docs: fix pydocstyle errors

fhchl · Sep 19, 2020 · 6c4761d · 6c4761d
1 parent 28d10ea
commit 6c4761d
Show file tree

Hide file tree

Showing 8 changed files with 5,222 additions and 15 deletions.
diff --git a/.gitignore b/.gitignore
@@ -44,6 +44,7 @@ nosetests.xml
 coverage.xml
 *,cover
 .hypothesis/
+.pytest_cache
 
 # Translations
 *.mo

diff --git a/.travis.yml b/.travis.yml
@@ -8,11 +8,11 @@ matrix:
       dist: xenial
       sudo: true
 install:
-  - pip install 'pytest>=3.6' pytest-cov codecov pydocstyle pycodestyle
-  - python setup.py install
+  - pip install codecov
+  - pip install .[dev]
 # command to run tests
 script:
-  - pytest --cov=response tests
+  - pytest --cov=response --doctest-modules tests
   - pydocstyle response.py
   - pycodestyle response.py
 after_success:

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -18,7 +18,7 @@ Git commit messages follow [Angular style][4]. Uses [python-semantic-release][5]
 
 Create documentation with
 
-    pdoc --html --force --output-dir build response.py
+    pdoc --html --force --output-dir docs response.py
 
 [1]: https://github.com/numpy/numpy/blob/master/doc/HOWTO_DOCUMENT.rst.txt
 [2]: http://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_numpy.html

diff --git a/README.md b/README.md
@@ -9,7 +9,7 @@ _Your handy frequency and impulse response processing object!_
 [![codecov](https://codecov.io/gh/fhchl/Response/branch/master/graph/badge.svg)](https://codecov.io/gh/fhchl/Response)
 
 This module supplies the `Response` class: an abstraction of frequency and
-impulse responses and a set of handy methods their its processing. It implements a
+impulse responses and a set of handy methods for their processing. It implements a
 [fluent interface][1] for chaining the processing commands.
 
 Find the documentation [here][2] and the source code on [GitHub][3].

diff --git a/docs/response.html b/docs/response.html
diff --git a/response.py b/response.py
@@ -1,22 +1,16 @@
-"""
-
-_Your handy frequency and impulse response processing object!_
+"""Your handy frequency and impulse response processing object.
 
 [![](https://img.shields.io/pypi/l/response.svg?style=flat)](https://pypi.org/project/response/)
 [![](https://img.shields.io/pypi/v/response.svg?style=flat)](https://pypi.org/project/response/)
 [![travis-ci](https://travis-ci.org/fhchl/Response.svg?branch=master)](https://travis-ci.org/fhchl/Response)
 [![codecov](https://codecov.io/gh/fhchl/Response/branch/master/graph/badge.svg)](https://codecov.io/gh/fhchl/Response)
 
 This module supplies the `Response` class: an abstraction of frequency and
-impulse responses and a set of handy methods their its processing. It implements a
+impulse responses and a set of handy methods for their processing. It implements a
 [fluent interface][1] for chaining the processing commands.
 
 Find the documentation [here][2] and the source code on [GitHub][3].
 
-[1]: https://en.wikipedia.org/wiki/Fluent_interface
-[2]: https://fhchl.github.io/Response/
-[3]: https://github.com/fhchl/Response
-
 ```python
 import numpy as np
 from response import Response
@@ -51,6 +45,10 @@
 # and much more ...
 ```
 
+[1]: https://en.wikipedia.org/wiki/Fluent_interface
+[2]: https://fhchl.github.io/Response/
+[3]: https://github.com/fhchl/Response
+
 """
 
 import warnings

diff --git a/setup.cfg b/setup.cfg
@@ -13,4 +13,4 @@ version_variable = setup.py:VERSION
 upload_to_pypi = true
 
 [tool:pytest]
-addopts = --doctest-modules
+addopts = --doctest-modules --cov response
diff --git a/setup.py b/setup.py
@@ -82,7 +82,9 @@ def run(self):
     url=URL,
     py_modules=["response"],
     install_requires=REQUIRED,
-    extras_require={'dev': ['pytest', 'pycodestyle', 'pydocstyle', 'pdoc3']},
+    extras_require={
+        'dev': ['pytest', 'pycodestyle', 'pydocstyle', 'pdoc3', 'pytest-cov']
+    },
     include_package_data=True,
     license="MIT",
     classifiers=[