-
-
Notifications
You must be signed in to change notification settings - Fork 32.1k
Doc: errors tutorial improvements #16269
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
Conversation
Review all try/except/raise/finally and surrounding those without any mark (like :keyword:) with *...*.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for the PR @adorilson.
Regarding the usage of asterisks, they are typically reserved for argument names, so I do not support the idea of using try clause or except clause. If anything, the emphasis should only surround "try" or "except". Additionally, it should be using either the Spinx keyword
role or inline code blocks. The Sphinx roles provide a specific functional purpose of linking to the documentation, so they are more beneficial when appropriately used.
Sphinx role example:
:keyword:`try` clause
Code block example:
``try`` clause
Also, while we typically require that any PRs changing or adding documentation fit within the 80 character line width limit for reST, it is discouraged to change an existing section solely for the purpose of fixing the wrapping, as this can add unnecessary clutter to the commit logs.
Co-Authored-By: Kyle Stanley <[email protected]>
Co-Authored-By: Kyle Stanley <[email protected]>
Co-Authored-By: Kyle Stanley <[email protected]>
Co-Authored-By: Kyle Stanley <[email protected]>
Hi, folks. What exactly I need to do here? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sorry for the delay, LGTM. (For clarification, I did not have commit privileges when I last left a review)
Improvements: - Improvements in how try clause works section This suggestion is because the execution continues after *except*, not after *try* but before *except*. I guess this form more clear. - Surrounding some keywords with \*...\* For uniformity the highlighted terms - Adjust the number of chars per line to 80
Improvements:
Improvements in how try clause works section
This suggestion is because the execution continues after except, not after try but before except. I guess this form more clear.
Surrounding some keywords with *...*
For uniformity the highlighted terms
Adjust the number of chars per line to 80
Automerge-Triggered-By: GH:aeros