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

Python: Clarify if order of docstring sections is fixed #847

Open
hassec opened this issue Aug 9, 2024 · 0 comments
Open

Python: Clarify if order of docstring sections is fixed #847

hassec opened this issue Aug 9, 2024 · 0 comments

Comments

@hassec
Copy link

hassec commented Aug 9, 2024 •
edited
Loading

The python style guide mentions the docstring sections Args, Returns/Yields and Raises but does not clearly specify whether their order is enforced.

All examples show

Args: ...

Returns: ...

Raises: ...

Should this be taken as the only acceptable order? Or would e.g. Raises: before Returns: be allowed?

Question arose in danymat/neogen#194
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@hassec