Skip to content

Commit

Permalink
moar readme
Browse files Browse the repository at this point in the history
  • Loading branch information
flying-sheep committed Dec 11, 2012
1 parent 77bd190 commit 6e1cbce
Show file tree
Hide file tree
Showing 2 changed files with 31 additions and 2 deletions.
31 changes: 30 additions & 1 deletion README.md
Expand Up @@ -7,4 +7,33 @@ The unbiased, generator-powered rewrite.
Q: Why is it better than the one coming with Python right now? Q: Why is it better than the one coming with Python right now?
-------------------------------------------------------------- --------------------------------------------------------------


A: because the `-i` option of the command line interface allows you to indent with tabs or 2 spaces or whatever you prefer. A: because the `-i` option of the command line interface allows you to indent with tabs or 2 spaces or whatever you prefer.

Q: What else? And how?
----------------------

A:

```
usage: reindent.py [-hvdnb] [-i spaces] [file [file ...]]
Reindents each input file. If none is given, code is read from stdin and
written to stdout. In this mode, all options except -i are ignored.
positional arguments:
file files (and directories) to reindent
optional arguments:
-h, --help show this help message and exit
-i spaces, --indentation spaces
indentation level depth. “0” means 1 tab
(default: 4 spaces)
-v, --verbose print information during run. can be used 2 times
(default: no output)
-d, --dry-run discard reindented file contents
(default: overwrite files)
-n, --no-recurse only reindent directly passed files
(default: also indent all scripts in passed directories)
-b, --no-backup prevent backup from being created
(default: create backup)
```
2 changes: 1 addition & 1 deletion reindent.py
Expand Up @@ -3,7 +3,7 @@
""" """
Reindents each input file. If none is given, Reindents each input file. If none is given,
code is read from stdin and written to stdout. code is read from stdin and written to stdout.
in this mode, all options except -i are ignored. In this mode, all options except -i are ignored.
""" """


#TODO: don’t change multiline strings that aren’t docstrings #TODO: don’t change multiline strings that aren’t docstrings
Expand Down

0 comments on commit 6e1cbce

Please sign in to comment.