Skip to content

Warn when section ordering is not according to spec #139

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

Closed
jnothman opened this issue Nov 1, 2017 · 2 comments
Closed

Warn when section ordering is not according to spec #139

jnothman opened this issue Nov 1, 2017 · 2 comments
Labels
docstring integrity feature enhancements to check docstring integrity help-wanted

Comments

@jnothman
Copy link
Member

jnothman commented Nov 1, 2017

in #121 we added documentation suggesting that docstring sections should be in specified order.

This should be augmented with a warning when the sections are out of order. This was the consensus at #68.

@jnothman jnothman added the docstring integrity feature enhancements to check docstring integrity label Apr 25, 2018
@rth
Copy link
Contributor

rth commented Oct 30, 2019

Somewhat related section ordering is now enforced in numpydoc.validate checker.

@larsoner
Copy link
Collaborator

Indeed, I think we should close this and people should use the validation function to check things like this. It's going to be a lot more usable than trying to read warnings during a Sphinx build.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docstring integrity feature enhancements to check docstring integrity help-wanted
Projects
None yet
Development

No branches or pull requests

3 participants