Skip to content
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.

Sign up for GitHub

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

Jump to bottom

[MNT] Add numpydoc validation to CI #146

Open
RNKuhns opened this issue Mar 9, 2023 · 3 comments
Open

[MNT] Add numpydoc validation to CI #146

RNKuhns opened this issue Mar 9, 2023 · 3 comments
Labels
code quality Code formatting and quality documentation Documentation & tutorials maintenance Continuous integration, unit testing & package distribution

Comments

@RNKuhns
Copy link
Contributor

RNKuhns commented Mar 9, 2023

Describe the maintenance issue

It would be good to add numpydoc validation to the CI routines. Some information is available on the numpydoc validation documentation.
@RNKuhns RNKuhns added maintenance Continuous integration, unit testing & package distribution documentation Documentation & tutorials code quality Code formatting and quality labels Mar 9, 2023
@RNKuhns
Copy link
Contributor Author

RNKuhns commented Mar 9, 2023

To validate a class on the command line there:

python -m numpydoc numpy.ndarray --validate

@RNKuhns
Copy link
Contributor Author

RNKuhns commented Mar 9, 2023

Looks like numpy/numpydoc/pull/454 should provide the functionality we want.

@fkiraly
Copy link
Contributor

fkiraly commented Mar 11, 2023

hm, would it substantially impact the current style of docstrings? I suppose the only way to find out is to run the check...

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
code quality Code formatting and quality documentation Documentation & tutorials maintenance Continuous integration, unit testing & package distribution
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@fkiraly @RNKuhns