For consistency of docstrings, I found this:
https://github.com/pandas-dev/pandas/blob/master/scripts/validate_docstrings.py

If copied into the root directory, it can be run on a specific class/method, for example:
python validate_docstrings.py sktime.classifiers.ensemble.TimeSeriesForestClassifier which returns:

7 Errors found:
	Docstring text (summary) should start in the line immediately after the opening quotes (not in the same line, or leaving a blank line in between)
	Parameters {check_input} not documented
	Parameter "n_estimators" type should use "int" instead of "integer"
	Parameter "criterion" type should use "str" instead of "string"
	Parameter "max_depth" type should use "int" instead of "integer"
	Parameter "max_features" type should use "str" instead of "string"
	Parameter "bootstrap" type should use "bool" instead of "boolean"
2 Warnings found:
	See Also section not found
	No examples section found

Apparently, it can also automatically return a CSV file of all classes/functions and their docstring errors/warnings, but that would require to adapt the function, as it's currently based on the pandas API.

Uh oh!

Improve integration testing and automatic unit testing #25

Description

Metadata

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

Issue actions