Skip to content
This repository was archived by the owner on Nov 3, 2023. It is now read-only.

Commit b429e69

Browse files
committed
Update README.rst to include config files and updated interpreters.
1 parent 21bf376 commit b429e69

File tree

1 file changed

+25
-1
lines changed

1 file changed

+25
-1
lines changed

README.rst

Lines changed: 25 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ Use `pip <http://pip-installer.org>`_ or easy_install::
2020
Alternatively, you can use ``pep257.py`` source file
2121
directly--it is self-contained.
2222

23-
**pep257** is tested with Python 2.6, 2.7, 3.2, 3.3
23+
**pep257** is tested with Python 2.6, 2.7, 3.2, 3.3, 3.4, pypy and pypy3.
2424

2525
Example
2626
-----------------------------------------------------------
@@ -130,3 +130,27 @@ are grouped as follows:
130130
+--------------+--------------------------------------------------------------+
131131
| D402 | First line should not be the function's "signature". |
132132
+--------------+--------------------------------------------------------------+
133+
134+
Configuration
135+
-----------------------------------------------------------
136+
``pep257`` looks for a config file in the root of the project (the common
137+
prefix of all checked files) and goes up in the directory tree until it finds
138+
one of the following files (in this order):
139+
140+
* ``setup.cfg``
141+
* ``tox.ini``
142+
* ``.pep257``
143+
144+
The first found file is read, and configurations in the ``[pep257]`` section
145+
are used, if such a section exists.
146+
147+
Config Example
148+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
149+
150+
.. code::
151+
152+
[pep257]
153+
verbose = true
154+
ignore = D100,D203,D405
155+
explain = true
156+

0 commit comments

Comments
 (0)