Merge pull request #93 from MarcoGorelli/pydocstyle

CI pass pydocstyle

README.rst

@@ -29,6 +29,9 @@ nbQA
 .. image:: https://interrogate.readthedocs.io/en/latest/_static/interrogate_badge.svg
    :target: https://github.com/econchick/interrogate
 
+.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
+   :target: https://github.com/psf/black
+
 Adapter to run any code-quality tool on a Jupyter notebook. Documentation is hosted here_.
 
 Prerequisites

azure-pipelines.yml

@@ -47,6 +47,7 @@ stages:
           flake8
           mypy .
           interrogate nbqa tests -v -c pyproject.toml
+          pydocstyle nbqa tests
         displayName: 'static analysis'
 
       - script: |
@@ -100,6 +101,7 @@ stages:
           flake8
           mypy .
           interrogate nbqa tests -v -c pyproject.toml
+          pydocstyle nbqa tests
         displayName: 'static analysis'
 
       - script: |

nbqa/__init__.py

@@ -1,6 +1,4 @@
-"""
-Attributes used by in docs / packaging.
-"""
+"""Attributes used by in docs / packaging."""
 
 __author__ = """Marco Gorelli"""
 __email__ = "m.e.gorelli@gmail.com"

nbqa/__main__.py

@@ -1,6 +1,4 @@
-"""
-Run third-party tool (e.g. :code:`mypy`) against notebook or directory.
-"""
+"""Run third-party tool (e.g. :code:`mypy`) against notebook or directory."""
 
 import argparse
 import configparser
@@ -277,7 +275,7 @@ def _replace_temp_python_file_references_in_out_err(
 def _replace_tmpdir_references(
     out: str, err: str, cwd: Optional[Path] = None
 ) -> Tuple[str, str]:
-    """
+    r"""
     Replace references to temporary directory name with current working directory.
 
     Parameters
@@ -475,7 +473,6 @@ def main(raw_args: Optional[List[str]] = None) -> None:
         Command-line arguments (if calling this function directly), defaults to
         :code:`None` if calling via command-line.
     """
-
     command, root_dir, kwargs = _parse_args(raw_args)
 
     notebooks = _get_notebooks(root_dir)

nbqa/put_magics_back_in.py

@@ -1,6 +1,4 @@
-"""
-Uncomment magic IPython lines from converted notebook.
-"""
+"""Uncomment magic IPython lines from converted notebook."""
 
 import re
 from typing import TYPE_CHECKING

nbqa/replace_magics.py

@@ -1,6 +1,4 @@
-"""
-Comment-out magic IPython lines from converted notebook.
-"""
+"""Comment-out magic IPython lines from converted notebook."""
 
 import re
 from typing import TYPE_CHECKING
@@ -18,7 +16,6 @@ def main(temp_python_file: "Path") -> None:
     temp_python_file
         Temporary Python file notebook was converted to.
     """
-
     with open(str(temp_python_file), "r") as handle:
         file = handle.read()
 

nbqa/save_source.py

@@ -24,7 +24,6 @@ def main(notebook: "Path", temp_python_file: "Path") -> None:
     temp_python_file
         Temporary Python file to save converted notebook in.
     """
-
     with open(notebook, "r") as handle:
         parsed_notebook = json.load(handle)
 

requirements-dev.txt

@@ -4,5 +4,6 @@ interrogate==1.2.0
 isort==5.0.9
 mypy==0.782
 pre-commit==2.6.0
+pydocstyle==5.0.2
 pytest==5.4.3
 pytest-cov==2.10.0

tests/__init__.py

@@ -1,3 +1 @@
-"""
-Necessary so we can run :code:`pytest`.
-"""
+"""Necessary so we can run :code:`pytest`."""

tests/conftest.py

@@ -1,6 +1,4 @@
-"""
-Define some fixtures that can be re-used between tests.
-"""
+"""Define some fixtures that can be re-used between tests."""
 
 import shutil
 from pathlib import Path

tests/data/__init__.py

@@ -1,3 +1 @@
-"""
-Necessary so we can run :code:`pytest`.
-"""
+"""Necessary so we can run :code:`pytest`."""