Skip to content
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.

Sign up for GitHub

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

Jump to bottom

docs: Review docstring return fields. #53

Open
SharafMohamed opened this issue Nov 20, 2024 · 0 comments
Open

docs: Review docstring return fields. #53

SharafMohamed opened this issue Nov 20, 2024 · 0 comments
Labels
enhancement New feature or request

Comments

@SharafMohamed
Copy link
Contributor

Request

Currently return fields are being used incorrectly in many docstrings. They are specifying the return type instead of describing what is being returned.

Possible implementation

Move information from the docstring summary into the return field. In some cases this may invalidate the need for a summary altogether.
@SharafMohamed SharafMohamed added the enhancement New feature or request label Nov 20, 2024
@SharafMohamed SharafMohamed changed the title Review docstring return fields. docs: Review docstring return fields. Nov 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@SharafMohamed