diff options
| author | Ilambharathi Kanniah <ilambharathik@gmail.com> | 2014-07-31 13:03:30 -0700 |
|---|---|---|
| committer | Ilambharathi Kanniah <ilambharathik@gmail.com> | 2014-07-31 13:03:30 -0700 |
| commit | a99d80346ba8b6d10ce75b5e9b65fe8ba8720c2b (patch) | |
| tree | ec3fabcac6d6406d615b5ad725938e5d9fe38cf6 | |
| parent | def3750145c10e58d3f3723344926b45581ea5fc (diff) | |
| download | pep8-a99d80346ba8b6d10ce75b5e9b65fe8ba8720c2b.tar.gz | |
Added variables table for clarity
| -rw-r--r-- | docs/intro.rst | 16 |
1 files changed, 16 insertions, 0 deletions
diff --git a/docs/intro.rst b/docs/intro.rst index f6498bf..3dbef25 100644 --- a/docs/intro.rst +++ b/docs/intro.rst @@ -122,6 +122,22 @@ You can also make pep8.py show the error text in different formats by using --fo $ pep8 testsuite/E40.py --format='%(path)s|%(row)d|%(col)d| %(code)s %(text)s' testsuite/E40.py|2|10| E401 multiple imports on one line +Variables in the ``custom`` format option:: + ++----------------+------------------+ +| **Variable** | **Significance** | ++================+==================+ +| ``path`` | File name | ++----------------+------------------+ +| ``row`` | Row number | ++----------------+------------------+ +| ``col`` | Column number | ++----------------+------------------+ +| ``code`` | Error code | ++----------------+------------------+ +| ``text`` | Error text | ++----------------+------------------+ + Quick help is available on the command line:: $ pep8 -h |