Added note about # noqa in getting-started.rst

This commit is contained in:
Preet Thakkar 2019-12-06 15:10:33 +05:30
parent 5e46429bfb
commit cc96315273
1 changed files with 7 additions and 0 deletions

View File

@ -97,6 +97,13 @@ To use linters locally, run:
$ tox -e lint
.. note::
Avoid using ``# noqa`` comments to suppress linter warnings - wherever
possible, warnings should be fixed instead. ``# noqa`` comments are
reserved for rare cases where the recommended style causes severe
readability problems.
Building Documentation
----------------------