Skip to content

Commit

Permalink
Add documentation to un-documented modules
Browse files Browse the repository at this point in the history
  • Loading branch information
chrishunt committed Jun 1, 2013
1 parent cdade7a commit b2b5af5
Show file tree
Hide file tree
Showing 5 changed files with 6 additions and 0 deletions.
2 changes: 2 additions & 0 deletions lib/cane/cli.rb
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@
require 'cane/cli/parser'

module Cane
# Command line interface. This passes off arguments to the parser and starts
# the Cane runner
module CLI
def run(args)
spec = Parser.parse(args)
Expand Down
1 change: 1 addition & 0 deletions lib/cane/cli/options.rb
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
require 'cane/default_checks'

module Cane
# Default options for command line interface
module CLI
def defaults(check)
check.options.each_with_object({}) {|(k, v), h|
Expand Down
1 change: 1 addition & 0 deletions lib/cane/default_checks.rb
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
require 'cane/doc_check'
require 'cane/threshold_check'

# Default checks performed when no checks are provided
module Cane
def default_checks
[
Expand Down
1 change: 1 addition & 0 deletions lib/cane/runner.rb
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
require 'cane/violation_formatter'
require 'cane/json_formatter'

# Accepts a parsed configuration and passes those options to a new Runner
module Cane
def run(*args)
Runner.new(*args).run
Expand Down
1 change: 1 addition & 0 deletions lib/cane/task_runner.rb
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
# Provides a SimpleTaskRunner or Parallel task runner based on configuration
module Cane
def task_runner(opts)
if opts[:parallel]
Expand Down

0 comments on commit b2b5af5

Please sign in to comment.