Skip to content

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

Closed
lucyleeow opened this issue Sep 6, 2022 · 3 comments
Closed

DOC Clarify documentation writing guideline #24369

lucyleeow opened this issue Sep 6, 2022 · 3 comments

Comments

@lucyleeow
Copy link
Member

lucyleeow commented Sep 6, 2022

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?

@ogrisel
Copy link
Member

ogrisel commented Sep 7, 2022

I don't think this is limited to docstrings. What makes you think so?

@lucyleeow
Copy link
Member Author

lucyleeow commented Sep 7, 2022

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.

  1. hand-waving explanation
  2. why method is useful and when it should be used
  3. figure
  4. code examples
  5. math and equations

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.

@MaxwellLZH MaxwellLZH removed the Needs Triage Issue requires triage label Sep 8, 2022
@lucyleeow
Copy link
Member Author

closing this as it seems the docstring section has been updated and the above guidelines is specified for the user guide, which makes sense.

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

Successfully merging a pull request may close this issue.

3 participants