-
-
Notifications
You must be signed in to change notification settings - Fork 25.8k
DOC Clarify documentation writing guideline #24369
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
Comments
I don't think this is limited to docstrings. What makes you think so? |
Fair, reading it again I can see how it has more general tips than I originally thought, though maybe not necessarily relevant for all types of documentation. I think the problem may better be described as: it seems very prescriptive, i.e., too specific in detailing exactly what to include and the order, e.g.
This may not be so relevant for all types of documentation, e.g., docstrings don't usually contain figures. I think this issue should be more - make the guide more general for all types of documentation and suggest what could be included in various types of documentation (instead of suggesting that all types of documentation should include all 5 items), but I am also happy to close this issue as this is not as much of a problem as I originally thought. |
closing this as it seems the docstring section has been updated and the above guidelines is specified for the user guide, which makes sense. |
Describe the issue linked to the documentation
The 'Guidelines for writing documentation' section seems to be specifically about docstrings and the suggestions don't seem to be as relevant for other types of documentation, e.g., example, tutorial, usage pages.
Suggest a potential alternative/fix
Clarify that this section is about docstrings. Potentially add sections on guidelines for writing examples, usage and tutorial pages?
The text was updated successfully, but these errors were encountered: