diff options
| author | cburroughs <chris.burroughs@gmail.com> | 2009-10-19 21:04:33 -0400 |
|---|---|---|
| committer | Johann C. Rocholl <johann@rocholl.net> | 2009-11-12 18:16:41 -0800 |
| commit | f091dee45f10b8a1538a330aa7afa7242659ce84 (patch) | |
| tree | 08119cf8a30b1377f3839d0081df043b271efb27 /README.rst | |
| parent | b564804f7a39c640f17c8a8ef15722f098219ddd (diff) | |
| download | pep8-f091dee45f10b8a1538a330aa7afa7242659ce84.tar.gz | |
Merging README with reality.
Diffstat (limited to 'README.rst')
| -rw-r--r-- | README.rst | 29 |
1 files changed, 22 insertions, 7 deletions
@@ -25,7 +25,6 @@ Installation Just an ``easy_install pep8`` ought to do the trick. -http://github.com/jcrocholl/pep8 Example usage and output ------------------------ @@ -73,28 +72,44 @@ Or you can display how often each error was found:: Quick help is available on the command line:: $ pep8 -h - usage: pep8 [options] input ... + Usage: pep8.py [options] input ... - options: + Options: -h, --help show this help message and exit -v, --verbose print status messages, or debug with -vv -q, --quiet report only file names, or nothing with -qq - --exclude=patterns skip matches (default .svn,CVS,*.pyc,*.pyo) - --filename=patterns only check matching files (e.g. *.py) + --exclude=patterns exclude files or directories which match these comma + separated patterns (default: .svn,CVS,.bzr,.hg,.git) + --filename=patterns when parsing directories, only check filenames matching + these comma separated patterns (default: *.py) --ignore=errors skip errors and warnings (e.g. E4,W) --repeat show all occurrences of the same error --show-source show source code for each error --show-pep8 show text of PEP 8 for each error --statistics count errors and warnings + --count count total number of errors and warnings --benchmark measure processing speed --testsuite=dir run regression tests from dir --doctest run doctest on myself - Feedback -------- Your feedback is more than welcome. Write email to johann@rocholl.net or post bugs and feature requests here: -http://github.com/jcrocholl/pep8/issues +http://github.com/cburroughs/pep8.py/issues + + +Source download +--------------- + +The source code is currently available on github. Fork away! + +http://github.com/cburroughs/pep8.py/ +http://github.com/jcrocholl/pep8/ + +(Yes it's lame two have two that are not forks of one another. At some +point in the future it is hoped some git magic will clean this +situating up.) + |