Skip to content

Commit

Permalink
ENH: Add flake8-rst-docstrings to our flake8 plugin collection
Browse files Browse the repository at this point in the history
Enables checking of formatting of docstrings.
  • Loading branch information
dopplershift committed Aug 20, 2019
1 parent 310b611 commit 7bf9052
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 3 deletions.
1 change: 1 addition & 0 deletions environment.yml
Expand Up @@ -30,6 +30,7 @@ dependencies:
- flake8-pep3101
- flake8-print
- flake8-quotes
- flake8-rst-docstrings
- pep8-naming
- pyproj
- cartopy
Expand Down
8 changes: 6 additions & 2 deletions setup.cfg
Expand Up @@ -3,7 +3,7 @@ ignore = W503
max-line-length = 95

[flake8]
ignore = F405 D999 W503
ignore = F405 D999 W503 RST306 RST902
max-line-length = 95
exclude = metpy/_version.py
application-import-names = metpy
Expand All @@ -12,18 +12,22 @@ copyright-check = True
copyright-author = MetPy Developers
inline-quotes = single
multiline-quotes = double
rst-roles = class, data, func, meth, mod
rst-directives = plot

[tool:pytest]
# https://github.com/matplotlib/pytest-mpl/issues/69
markers = mpl_image_compare
norecursedirs = build docs .idea
flake8-ignore = *.py F405 W503
flake8-ignore = *.py F405 W503 RST902
examples/*.py D T003 T001
tutorials/*.py D T003 T001
versioneer.py ALL
deprecation.py C801
metpy/calc/__init__.py D999
metpy/calc/*.py RST306
metpy/interpolate/__init__.py D999
metpy/interpolate/*.py RST306
metpy/io/__init__.py D999
metpy/plots/__init__.py D999
flake8-max-line-length = 95
Expand Down
2 changes: 1 addition & 1 deletion setup.py
Expand Up @@ -63,7 +63,7 @@
'cartopy>=0.16.0', 'flake8>3.2.0', 'flake8-builtins!=1.4.0',
'flake8-comprehensions', 'flake8-copyright',
'flake8-docstrings', 'flake8-import-order', 'flake8-mutable',
'flake8-pep3101', 'flake8-print', 'flake8-quotes',
'flake8-pep3101', 'flake8-print', 'flake8-quotes', 'flake8-rst-docstrings',
'pep8-naming', 'netCDF4', 'pyproj>=1.9.4,!=2.0.0']
},

Expand Down

0 comments on commit 7bf9052

Please sign in to comment.