Skip to content

Commit 56a9882

Browse files
committed
Improved formatting of filename referencing in docs
1 parent f8bd693 commit 56a9882

File tree

3 files changed

+13
-13
lines changed

3 files changed

+13
-13
lines changed

README.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,14 +20,14 @@ Features
2020
* Parseable output: Jump to error location in your editor.
2121

2222
* Small: Just one Python file, requires only stdlib. You can use just
23-
the pycodestyle.py file for this purpose.
23+
the ``pycodestyle.py`` file for this purpose.
2424

2525
* Comes with a comprehensive test suite.
2626

2727
Installation
2828
------------
2929

30-
You can install, upgrade, uninstall pycodestyle.py with these commands::
30+
You can install, upgrade, uninstall ``pycodestyle.py`` with these commands::
3131

3232
$ pip install pycodestyle
3333
$ pip install --upgrade pycodestyle
@@ -51,7 +51,7 @@ Example usage and output
5151
optparse.py:472:29: E221 multiple spaces before operator
5252
optparse.py:544:21: W601 .has_key() is deprecated, use 'in'
5353

54-
You can also make pycodestyle.py show the source code for each error, and
54+
You can also make ``pycodestyle.py`` show the source code for each error, and
5555
even the relevant text from PEP 8::
5656

5757
$ pycodestyle --show-source --show-pep8 testsuite/E40.py

docs/developer.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -89,11 +89,11 @@ Several docstrings contain examples directly from the `PEP 8`_ document.
8989
Okay: spam(ham[1], {eggs: 2})
9090
E201: spam( ham[1], {eggs: 2})
9191

92-
These examples are verified automatically when pycodestyle.py is run with the
93-
``--doctest`` option. You can add examples for your own check functions.
94-
The format is simple: ``"Okay"`` or error/warning code followed by colon
95-
and space, the rest of the line is example source code. If you put ``'r'``
96-
before the docstring, you can use ``\n`` for newline and ``\t`` for tab.
92+
These examples are verified automatically when ``pycodestyle.py`` is run with
93+
the ``--doctest`` option. You can add examples for your own check functions.
94+
The format is simple: ``"Okay"`` or error/warning code followed by colon and
95+
space, the rest of the line is example source code. If you put ``'r'`` before
96+
the docstring, you can use ``\n`` for newline and ``\t`` for tab.
9797

9898
Then be sure to pass the tests::
9999

docs/intro.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Features
1818
* Parseable output: Jump to error location in your editor.
1919

2020
* Small: Just one Python file, requires only stdlib. You can use just
21-
the pycodestyle.py file for this purpose.
21+
the ``pycodestyle.py`` file for this purpose.
2222

2323
* Comes with a comprehensive test suite.
2424

@@ -55,7 +55,7 @@ the ``pycodestyle`` library:
5555
Installation
5656
------------
5757

58-
You can install, upgrade, uninstall pycodestyle.py with these commands::
58+
You can install, upgrade, uninstall ``pycodestyle.py`` with these commands::
5959

6060
$ pip install pycodestyle
6161
$ pip install --upgrade pycodestyle
@@ -77,7 +77,7 @@ Example usage and output
7777
optparse.py:472:29: E221 multiple spaces before operator
7878
optparse.py:544:21: W601 .has_key() is deprecated, use 'in'
7979

80-
You can also make pycodestyle.py show the source code for each error, and
80+
You can also make ``pycodestyle.py`` show the source code for each error, and
8181
even the relevant text from PEP 8::
8282

8383
$ pycodestyle --show-source --show-pep8 testsuite/E40.py
@@ -106,8 +106,8 @@ Or you can display how often each error was found::
106106
612 W601 .has_key() is deprecated, use 'in'
107107
1188 W602 deprecated form of raising exception
108108

109-
You can also make pycodestyle.py show the error text in different formats by
110-
using --format having options default/pylint/custom::
109+
You can also make ``pycodestyle.py`` show the error text in different formats by
110+
using ``--format`` having options default/pylint/custom::
111111

112112
$ pycodestyle testsuite/E40.py --format=default
113113
testsuite/E40.py:2:10: E401 multiple imports on one line

0 commit comments

Comments
 (0)