Skip to content

Commit

Permalink
Added a link to generated CLI documentation. Clarified some things. U…
Browse files Browse the repository at this point in the history 
…pdated example output to (almost) match reality.
  • Loading branch information
@CleanCut
CleanCut committed Aug 14, 2014
1 parent 89436cb commit 83b22c6
Showing 1 changed file with 8 additions and 4 deletions.
12 changes: 8 additions & 4 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -141,7 +141,9 @@ To run Green's own internal unit tests:
Advanced Usage
--------------

For a list of all command-line and config-file options, please run `green --help`
See the [complete command-line
options](https://github.com/CleanCut/silk/blob/master/cli-option.txt) or run
`green --help`.


Integration
Expand Down Expand Up @@ -352,7 +354,7 @@ shines when you start getting more verbose:
**In a real terminal, this output is syntax highlighted**

$ green -vv proj
test.test_foo
proj.test.test_foo
TestAnswer
. answer() returns 42
. answer() returns an integer
Expand All @@ -368,9 +370,11 @@ Notes:

1. Green outputs clean, heirarchical output.

2. Test status is aligned on the _left_
2. Test status is aligned on the _left_ (the four periods correspond to four
passing tests)

3. Method names are replaced with docstrings when present.
3. Method names are replaced with docstrings when present. The first two tests
have docstrings you can see.

4. Green always outputs a summary of statuses that will add up to the total
number of tests that were run. For some reason, many test runners forget
Expand Down

0 comments on commit 83b22c6

Please sign in to comment.