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
Two docstring style guides #26387
Comments
@moorepants Good evening sir should we remove the one in the docstring style guide or anything else please clear more specifically this issue. how to tackle this issue sir ? |
I don't know how to tackle it. Maybe figure out who added them both as ask them about it. |
@moorepants can I work on this issue I think docstring style guide comes under general guidelines |
I think that they were added in the PR #21894, so they could be intentional |
The two guides have separate information. The second guide is misleadingly named because it primarily deals with things for RST files, not docstrings. The filename is more accurate. Although much of what is in it also applies to docstrings. #21894 did intentionally split did intentionally split this, but I don't know if it's been helpful. Perhaps we should merge the two guides, and just be clear about which parts do not apply to docstrings (for example, docstrings currently cannot be written in Markdown, and cannot use different heading levels). |
So maybe the fix is "Documentation Style Guide" and "Docstring Style Guide" as the two names. |
There seems to be two docstring style guides in the dev documentation:
First:
Second:
The text was updated successfully, but these errors were encountered: