Skip to content

Reorganize documentation to display parameters and return values more prominently #518

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
kgryte opened this issue Nov 27, 2022 · 0 comments · Fixed by #578
Closed

Reorganize documentation to display parameters and return values more prominently #518

kgryte opened this issue Nov 27, 2022 · 0 comments · Fixed by #578
Assignees
Labels
Document Formatting Document formatting or styling. Maintenance Bug fix, typo fix, or general maintenance.
Milestone

Comments

@kgryte
Copy link
Contributor

kgryte commented Nov 27, 2022

As discussed in a comment, we should reorganize docstring content such that parameters and return values are documented immediately after the interface definition and initial description and such that explanatory notes, including special cases, are documented in a separate section immediately following documentation of return values and/or raised exceptions.

This reorganization will ensure that parameters and return values are more prominently displayed and are closer in proximity to the API definition. Currently, for those APIs with many floating-point special cases, a definition and its associated parameter descriptions can be spaced far apart, thus requiring a user to scroll to view desired content and preventing the user from viewing the definition and associated descriptions within the same view at the same time.

@kgryte kgryte added Document Formatting Document formatting or styling. Maintenance Bug fix, typo fix, or general maintenance. labels Nov 27, 2022
@kgryte kgryte added this to the v2022 milestone Nov 27, 2022
@kgryte kgryte self-assigned this Dec 19, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Document Formatting Document formatting or styling. Maintenance Bug fix, typo fix, or general maintenance.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant