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

Review if_transient_error docstrings #569

Open
daniel-sanche opened this issue Dec 8, 2023 · 0 comments
Open

Review if_transient_error docstrings #569

daniel-sanche opened this issue Dec 8, 2023 · 0 comments
Labels
type: docs Improvement to the documentation for an API.

Comments

@daniel-sanche
Copy link
Contributor

Context in this thread

doc: I'm fine with the function-type naming you have, but if Python treats this as a constant, we should make sure the documentation format is appropriate for that so it shows up in IDEs, etc. Is the triple-quoted form the right format for constants' comments? I only recall the hash-prefixed form. It seems triple-quoted strings get assigned to doc when they are "the first statement in a module, function, class, or method definition" (https://peps.python.org/pep-0257/). Elsewhere, they may just get executed (i.e. printed out) when the interpreter encounters that line, which in this case would be on module load.

@parthea parthea added the type: docs Improvement to the documentation for an API. label Dec 10, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: docs Improvement to the documentation for an API.
Projects
None yet
Development

No branches or pull requests

2 participants