diff options
| author | Ian Lee <IanLee1521@gmail.com> | 2016-05-31 11:16:32 -0700 |
|---|---|---|
| committer | Ian Lee <IanLee1521@gmail.com> | 2016-05-31 11:16:32 -0700 |
| commit | 56a9882ec8bea2fe3dc10ab5477187e57468f970 (patch) | |
| tree | 624890b5e36bc68bdf6508dc8910856a630a759b /docs/intro.rst | |
| parent | f8bd6939d42037287f17ac3b048bdbdf0f2dd1b5 (diff) | |
| download | pep8-56a9882ec8bea2fe3dc10ab5477187e57468f970.tar.gz | |
Improved formatting of filename referencing in docs
Diffstat (limited to 'docs/intro.rst')
| -rw-r--r-- | docs/intro.rst | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/docs/intro.rst b/docs/intro.rst index 2281ef1..5a46a02 100644 --- a/docs/intro.rst +++ b/docs/intro.rst @@ -18,7 +18,7 @@ Features * Parseable output: Jump to error location in your editor. * Small: Just one Python file, requires only stdlib. You can use just - the pycodestyle.py file for this purpose. + the ``pycodestyle.py`` file for this purpose. * Comes with a comprehensive test suite. @@ -55,7 +55,7 @@ the ``pycodestyle`` library: Installation ------------ -You can install, upgrade, uninstall pycodestyle.py with these commands:: +You can install, upgrade, uninstall ``pycodestyle.py`` with these commands:: $ pip install pycodestyle $ pip install --upgrade pycodestyle @@ -77,7 +77,7 @@ Example usage and output optparse.py:472:29: E221 multiple spaces before operator optparse.py:544:21: W601 .has_key() is deprecated, use 'in' -You can also make pycodestyle.py show the source code for each error, and +You can also make ``pycodestyle.py`` show the source code for each error, and even the relevant text from PEP 8:: $ pycodestyle --show-source --show-pep8 testsuite/E40.py @@ -106,8 +106,8 @@ Or you can display how often each error was found:: 612 W601 .has_key() is deprecated, use 'in' 1188 W602 deprecated form of raising exception -You can also make pycodestyle.py show the error text in different formats by -using --format having options default/pylint/custom:: +You can also make ``pycodestyle.py`` show the error text in different formats by +using ``--format`` having options default/pylint/custom:: $ pycodestyle testsuite/E40.py --format=default testsuite/E40.py:2:10: E401 multiple imports on one line |