Update Standard Library sys documentation#9427
Merged
Merged
Conversation
jepler
requested changes
Jul 13, 2024
RetiredWizard
commented
Jul 15, 2024
.. so that the reader of the documentation can readily get to the `traceback.print_exception` docs
jepler
previously approved these changes
Jul 22, 2024
jepler
left a comment
There was a problem hiding this comment.
This is fine if it's green (I tweaked the markup so that traceback and traceback.print_exception would become hyperlinks). However, we might also just choose to remove this non-standard python extension: #9446 and should consider which to do.
jepler
approved these changes
Jul 23, 2024
jepler
left a comment
There was a problem hiding this comment.
Thanks. We need to remember to remove this in the main branch, now, but it's also nice to have the other non-applicable docs removed.
Merged
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
I noticed the Circuit Python documentation for the Standard library sys doesn't include an entry for the print_exception function and that a couple attributes which are present in Micropython but not in Circuit Python (tracebacklimit and ps1/ps2) were included in the Circuit Python documentation.
I found the sys.rst file which appears to be the documentation source so I've updated it by adding/removing the appropriate sections.