Skip to content

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

Closed
@kgryte

Description

@kgryte

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.

Metadata

Metadata

Assignees

Labels

Document FormattingDocument formatting or styling.MaintenanceBug fix, typo fix, or general maintenance.

Type

No type

Projects

No projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions