pre-commit/flake8
1
0
Fork 0
mirror of https://github.com/PyCQA/flake8.git synced 2026-04-08 05:54:17 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Add and fix documentation

Browse source 
- Add more documentation around utils functions
- Fix documentation about default formatting plugins
- Add extra documentation of filenames_from predicate parameter
- Add test for the default parameter of flake8.utils.fnmatch
This commit is contained in:
Ian Cordasco 2016-02-25 09:06:45 -06:00
parent cd18b9f175
commit a4e984dbd2
5 changed files with 67 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

8
docs/source/internal/formatters.rst
View file

@ -30,7 +30,7 @@ The former allows us to inspect the value provided to ``--format`` by the
user and alter our own format based on that value. The second simply uses
that format string to format the error.
.. autoclass:: flake8.formatters.default.Default
.. autoclass:: flake8.formatting.default.Default
:members:
Pylint Formatter
@ -39,9 +39,9 @@ Pylint Formatter
The |PylintFormatter| simply defines the default Pylint format string from
pep8: ``'%(path)s:%(row)d: [%(code)s] %(text)s'``.
.. autoclass:: flake8.formatters.default.Pylint
.. autoclass:: flake8.formatting.default.Pylint
:members:
.. |DefaultFormatter| replace:: :class:`~flake8.formatters.default.Default`
.. |PylintFormatter| replace:: :class:`~flake8.formatters.default.Pylint`
.. |DefaultFormatter| replace:: :class:`~flake8.formatting.default.Default`
.. |PylintFormatter| replace:: :class:`~flake8.formatting.default.Pylint`