NeuralEnsemble / elephant / 27610293580

89%

Build Type

push

github

Committed by web-flow

Commit Message

[Enh] Activating numpydoc validation during Sphinx build (#694)

* Added patch to avoid error if properties have docstrings, when using numpydoc docstring validation

* Enabled numpydoc validation for basic docstring structure

* Fixes for GL02 and GL03, concerning extra line breaks within or at the end of the docstring

* Fixes for GL06, concerning wrong naming and typos in the main docstring sections

* Fixes for GL07, concerning the wrong order of the docstring sections

* Fixes for SS03, concerning missing period at the end of the summary (first) sentence.

* Fixes for SA02, concerning missing periods at the end of the entries in See Also section.

* Fixes for PR02, concerning missing parameters in the docstring (also catches missing space between parameter name and separator :).

* Fixes for PR05, concerning periods at the end of the parameter type

* Fixes for PR06, concerning wrong parameter types

* Fixes related to GL01, concerning missing line-break from the triple quote token

* Added GL05, concerning tabs instead of spaces in indentations

* Added SS02 and SS04, concerning summary starting with capital letter and no leading spaces

* Fixes for PR03, concerning matching the order of parameters in the docstring to the order in the function signature

* Fixes for PR08, concerning parameter description not starting with a capital letter.

* Comment on PR09, that cannot be used due to the information on defaults

* Added PR10, concerning missing space between the colon separator in the parameter type specification

* Fixes for SA03, concerning See Also descriptions not starting with capital letter.

* Added PR07, for checking undocumented parameters.

* Fixes for RT04, concerning that the description of returns start with a capital letter.

* Fixes for RT05, concerning that the description of returns ends with a period.

* Fixed warnings due to indentations in the window parameter description

* Fixed warnings due to indentations in the descrip... (continued)

Coverage Stats

3 of 3 new or added lines in 1 file covered. (100.0%)

7 existing lines in 2 files now uncovered.

6835 of 7714 relevant lines covered (88.61%)

2.22 hits per line