[Enh] Activating numpydoc validation during Sphinx build by kohlerca · Pull Request #694 · NeuralEnsemble/elephant

Commits on Apr 13, 2026

Added patch to avoid error if properties have docstrings, when using numpydoc docstring validation
kohlerca
committed
c02fbcd
Enabled numpydoc validation for basic docstring structure
kohlerca
committed
bf71652
Fixes for GL02 and GL03, concerning extra line breaks within or at the end of the docstring
kohlerca
committed
a0c96ca
Fixes for GL06, concerning wrong naming and typos in the main docstring sections
kohlerca
committed
d555e92
Fixes for GL07, concerning the wrong order of the docstring sections
kohlerca
committed
90117e1
Fixes for SS03, concerning missing period at the end of the summary (first) sentence.
kohlerca
committed
0b48db6

Commits on Apr 14, 2026

Commits on Apr 15, 2026

Fixes for RT05, concerning that the description of returns ends with a period.
kohlerca
committed
f5a85ff

Commits on Apr 16, 2026

Commits on Apr 22, 2026

Commits on Jun 9, 2026

Merge branch 'master' into feature/docstring_validation
CozySocksAlways
authored
05d3b22

Commits on Jun 16, 2026

Merge branch 'master' into feature/docstring_validation
CozySocksAlways
authored
78b5c7a
Fixed typo in doc/conf.py

kohlerca
and
CozySocksAlways
authored
8073686

Navigation Menu

Uh oh!

[Enh] Activating numpydoc validation during Sphinx build - #694

[Enh] Activating numpydoc validation during Sphinx build#694
CozySocksAlways merged 28 commits into
NeuralEnsemble:masterfrom
INM-6:feature/docstring_validation

Commits on Apr 13, 2026

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.

Commits on Apr 14, 2026

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.

Commits on Apr 15, 2026

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

Commits on Apr 16, 2026

Fixed warnings due to indentations in the window parameter description

Fixed warnings due to indentations in the description of instantaneous_rate returns

Commits on Apr 22, 2026

Added GL01, with remarks for expected warnings.

Fixed issues related to RT05, concerning the lack of a period at the end of the description of returns.

Commits on Jun 9, 2026

Merge branch 'master' into feature/docstring_validation

Commits on Jun 16, 2026

Merge branch 'master' into feature/docstring_validation

Fixed typo in doc/conf.py