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.

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

Document how return types and return values should be used in docstrign signature lines #57583

Open
wants to merge 4 commits into
base: master
Choose a base branch
from

Conversation

LilithHafner
Copy link
Member

Implements the first step in #57012 (comment). See the discussion there for more info. Once this merges, #57012 will implement the recommended method throughout base and in-tree stdlibs.

@LilithHafner LilithHafner added the docs This change adds or pertains to documentation label Feb 28, 2025
@nsajko
Copy link
Contributor

nsajko commented Feb 28, 2025

Perhaps also add to the style guide in the manual?

@LilithHafner
Copy link
Member Author

Perhaps also add to the style guide in the manual?

Yep! That's #57580

@nickrobinson251
Copy link
Contributor

thumbs down because #57012 (comment) (sorry i didn't see this discussion til this PR, so understand this might have been decided, but i do think it could have an unintended consequence if it spreads an anti-pattern in code itself)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs This change adds or pertains to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants