Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Make parameter docstrings match function/constuctor signatures

See original GitHub issue

Continue #9206 and finish up the rest of the docstrings.

Uncomment the untested modules in sklearn/tests/test_docstring_parameters.py, fix doc inconsistencies and make all tests pass.

todo (modules)

‘sklearn.cross_decomposition’, (@clemkoa)
‘sklearn.discriminant_analysis’, (@clemkoa)
‘sklearn.ensemble’, (@clemkoa)
‘sklearn.feature_selection’, (@clemkoa)
‘sklearn.kernel_approximation’, (@clemkoa)
‘sklearn.model_selection’,
‘sklearn.multioutput’,
‘sklearn.random_projection’, #11405
‘sklearn.svm’ #11405

Issue Analytics

State:
Created 6 years ago
Reactions:1
Comments:17 (17 by maintainers)

Top GitHub Comments

1reaction

souravsinghcommented, Sep 14, 2017

@vrishank97 I will put a PR for fixing the docstrings in a few minutes

1reaction

clemkoacommented, Sep 13, 2017

I’ll take
‘sklearn.ensemble’, ‘sklearn.feature_selection’, ‘sklearn.kernel_approximation’

for the next one!

Edit: been really busy lately so if anybody wants to take these it’s fine, just leave a comment. Sorry for the delay

Top Results From Across the Web

Tool to compare function signature to docstring - Stack Overflow

I just created a tool to achieve this, called pydoctest . It will attempt to infer the types in your docstrings (not just...

autodoc pulls parent constructor docstring when subclass has ...

I'm guessing this behavior matches how function docstrings are inherited. For functions this behavior makes sense because, I think, modifying ...

Style guide — numpydoc v1.6.0rc1.dev0 Manual

The function signature is normally found by introspection and displayed by the ... Parameters section of the docstring details the constructor's parameters.

PEP 257 – Docstring Conventions

The one-line docstring should NOT be a “signature” reiterating the function/method parameters (which can be obtained by introspection).

Documenting Python APIs with docstrings

'Parameters' is a description of a function or method's arguments and their respective types. Parameters should be listed in the same order as...