diff options
Diffstat (limited to 'docs/developer.rst')
| -rw-r--r-- | docs/developer.rst | 18 |
1 files changed, 9 insertions, 9 deletions
diff --git a/docs/developer.rst b/docs/developer.rst index bbafb80..0aefbed 100644 --- a/docs/developer.rst +++ b/docs/developer.rst @@ -1,4 +1,4 @@ -.. currentmodule:: pep8 +.. currentmodule:: pycodestyle ================= Developer's notes @@ -13,7 +13,7 @@ conditions of the :ref:`Expat license <license>`. Fork away! * `Source code <https://github.com/pycqa/pycodestyle>`_ and `issue tracker <https://github.com/pycqa/pycodestyle/issues>`_ on GitHub. -* `Continuous tests <http://travis-ci.org/pycqa/pep8>`_ against Python +* `Continuous tests <http://travis-ci.org/pycqa/pycodestyle>`_ against Python 2.6 through 3.4 and PyPy, on `Travis-CI platform <http://about.travis-ci.org/>`_. @@ -25,14 +25,14 @@ Direction Some high-level aims and directions to bear in mind for contributions: -* ``pep8`` is intended to be as fast as possible. +* ``pycodestyle`` is intended to be as fast as possible. Using the ``ast`` module defeats that purpose. The `pep8-naming <https://github.com/flintwork/pep8-naming>`_ plugin exists for this sort of functionality. * If you want to provide extensibility / plugins, please see `flake8 <https://gitlab.com/pycqa/flake8>`_ - - ``pep8`` doesn't want or need a plugin architecture. + ``pycodestyle`` doesn't want or need a plugin architecture. * Python 2.6 support is still deemed important. -* ``pep8`` aims to have no external dependencies. +* ``pycodestyle`` aims to have no external dependencies. Contribute @@ -89,7 +89,7 @@ Several docstrings contain examples directly from the `PEP 8`_ document. Okay: spam(ham[1], {eggs: 2}) E201: spam( ham[1], {eggs: 2}) -These examples are verified automatically when pep8.py is run with the +These examples are verified automatically when pycodestyle.py is run with the ``--doctest`` option. You can add examples for your own check functions. The format is simple: ``"Okay"`` or error/warning code followed by colon and space, the rest of the line is example source code. If you put ``'r'`` @@ -97,9 +97,9 @@ before the docstring, you can use ``\n`` for newline and ``\t`` for tab. Then be sure to pass the tests:: - $ python pep8.py --testsuite testsuite - $ python pep8.py --doctest - $ python pep8.py --verbose pep8.py + $ python pycodestyle.py --testsuite testsuite + $ python pycodestyle.py --doctest + $ python pycodestyle.py --verbose pycodestyle.py When contributing to pycodestyle, please observe our `Code of Conduct`_. |