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

Update Standard Library sys documentation #9427

Merged
merged 4 commits into from
Jul 23, 2024
Merged

Conversation

RetiredWizard
Copy link

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.

@dhalbert dhalbert requested a review from jepler July 13, 2024 11:02
docs/library/sys.rst Outdated Show resolved Hide resolved
docs/library/sys.rst Outdated Show resolved Hide resolved
@dhalbert dhalbert requested review from tannewt and jepler July 20, 2024 16:24
.. so that the reader of the documentation can readily get to the `traceback.print_exception` docs
jepler
jepler previously approved these changes Jul 22, 2024
Copy link
Member

@jepler jepler left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Member

@jepler jepler left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Member

@tannewt tannewt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you! #9451 filed to remember to remove it in 10.

@tannewt tannewt merged commit 3865456 into adafruit:main Jul 23, 2024
12 checks passed
@RetiredWizard RetiredWizard deleted the sysdoc branch July 23, 2024 16:50
@jepler jepler mentioned this pull request Jul 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants