Skip to content

Commit

Permalink
Document suggested ignores for Google style
Browse files Browse the repository at this point in the history
Should address #17.
  • Loading branch information
peterjc committed Aug 11, 2020
1 parent f82b46f commit 2c7a584
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -212,6 +212,18 @@ for example in your ``.flake8``, ``setup.cfg``, or ``tox.ini`` file, e.g.::
Note that flake8 allows splitting the comma separated lists over multiple
lines, and allows including of hash comment lines.

If you are using the `Google Python Style
<https://google.github.io/styleguide/pyguide.html#s3.8-comments-and-docstrings>`_
you will sometimes get unwanted warnings from this plugin - particularly in the
argument descriptions - as it does not use strict RST. We therefore currently
suggest ignoring some of the violation codes::

[flake8]
extend-ignore =
# Google Python style is not RST until after processed by Napoleon
# See https://github.com/peterjc/flake8-rst-docstrings/issues/17
RST203,RST301,


Version History
---------------
Expand Down

0 comments on commit 2c7a584

Please sign in to comment.