Skip to content

DOC: Validation of docsting validates Python type doc #27055

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
datapythonista opened this issue Jun 26, 2019 · 2 comments
Open

DOC: Validation of docsting validates Python type doc #27055

datapythonista opened this issue Jun 26, 2019 · 2 comments
Labels
CI Continuous Integration Docs

Comments

@datapythonista
Copy link
Member

Our script scripts/validate_docstrings.py validates that docstrings in our code follow certain standards (the right parameters are documented, the docstring contain examples, capitalization and punctuation...).

There is currently one case when the validation is incorrect. See this (hypothetical) example:

class Series:
    ndim = 1

If we execute ./scripts/validate_docstrings.py pandas.Series.ndim, we'd expect the script to detect that ndim doesn't have a docstring. But instead, the script is validating the docstring of the type int (the doc of the scalar 1).

This is happening in practice for offset, and is preventing us to validate some error types to the CI. See: #26982 (comment)

We should detect this case in the script, and not validate the docstrings of attributes.

@datapythonista datapythonista added Docs CI Continuous Integration labels Jun 26, 2019
@davefol
Copy link

davefol commented Jul 29, 2019

I'm willing to take this on.

@datapythonista
Copy link
Member Author

@galuhsahid looks like we've got an issue for the problem we discussed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CI Continuous Integration Docs
Projects
None yet
Development

No branches or pull requests

2 participants