Change Details

Starting with the 4.0 release of [[ https://github.com/PyCQA/pydocstyle | pydocstyle ]], the tool [[ https://github.com/PyCQA/pydocstyle/issues/275 | supports the Google/Napoleon docstring convention ]] (the doc isn't fully consistent in saying it does, but yes, it really does !). To use it: ``` $ pip3 install pydocstyle $ pydocstyle --convention=google foo.py ``` We should lint all our docstrings with pydocstyle (and yes, reaching 0 warnings/errors it's gonna take a while…).

Starting with the 4.0 release of [[ https://github.com/PyCQA/pydocstyle | pydocstyle ]], the tool [[ https://github.com/PyCQA/pydocstyle/issues/275 | supports ]] the [[ https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html | Google/Napoleon docstring convention ]] that we use for Software Heritage development (the pydocstyle documentation isn't yet fully consistent in saying it does, but yes, it really does !). To use it: ``` $ pip3 install pydocstyle $ pydocstyle --convention=google foo.py ``` We should lint all our docstrings with pydocstyle (and yes, reaching 0 warnings/errors it's gonna take a while…).

Starting with the 4.0 release of [[ https://github.com/PyCQA/pydocstyle | pydocstyle ]], the tool [[ https://github.com/PyCQA/pydocstyle/issues/275 | supports the]] the [[ https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html | Google/Napoleon docstring convention ]] (ththat we use for Software Heritage development (the pydocstyle documentation isn'tt yet fully consistent in saying it does, but yes, it really does !). To use it: ``` $ pip3 install pydocstyle $ pydocstyle --convention=google foo.py ``` We should lint all our docstrings with pydocstyle (and yes, reaching 0 warnings/errors it's gonna take a while…).