Skip to content

Commit a99d803

Browse files
committed
Added variables table for clarity
1 parent def3750 commit a99d803

1 file changed

Lines changed: 16 additions & 0 deletions

File tree

docs/intro.rst

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -122,6 +122,22 @@ You can also make pep8.py show the error text in different formats by using --fo
122122
$ pep8 testsuite/E40.py --format='%(path)s|%(row)d|%(col)d| %(code)s %(text)s'
123123
testsuite/E40.py|2|10| E401 multiple imports on one line
124124

125+
Variables in the ``custom`` format option::
126+
127+
+----------------+------------------+
128+
| **Variable** | **Significance** |
129+
+================+==================+
130+
| ``path`` | File name |
131+
+----------------+------------------+
132+
| ``row`` | Row number |
133+
+----------------+------------------+
134+
| ``col`` | Column number |
135+
+----------------+------------------+
136+
| ``code`` | Error code |
137+
+----------------+------------------+
138+
| ``text`` | Error text |
139+
+----------------+------------------+
140+
125141
Quick help is available on the command line::
126142

127143
$ pep8 -h

0 commit comments

Comments
 (0)