-
-
Notifications
You must be signed in to change notification settings - Fork 29.8k
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
Add Additional Context Around Python Signal Handling on iOS #121881
base: main
Are you sure you want to change the base?
Conversation
Is there a better way to test the rendering of the .rst file than with rst2html.py? |
There is - when a PR includes documentation changes, the PR body is automatically updated to include a preview rendering. Alternatively, you can render locally using Sphinx. The CPython developer guide has a section on building the docs locally |
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.
This needs line breaks; documentation should be wrapped at 80 characters.
I'm also not convinced this is the best location for this comment; it breaks the bullet-point flow of "things that need to be done" (including, but not limited to the punctuation inconsistency).
I'd suggest moving this comment out of the bullet point flow, an into a paragraph following the discussion of "your apps bundle location" (i.e., a paragraph in "item 10", but not in the "things to do" bullet points.
I think the text itself also needs some modification so that it is more directly actionable.
.. note::
Python's default signal handlers will catch the UNIX signals ``SIGPIPE``,
``SIGXFZ``, ``SIGXFSZ``, and ``SIGINT``. These default handlers should be
able to co-exist with most third-party iOS crash reporting libraries; but
if you experience problems, you can omit the default handlers as long as
you manage these signals yourself.
A Python core developer has requested some changes be made to your pull request before we can consider merging it. If you could please address their requests along with any other requests in other reviews from core developers that would be appreciated. Once you have made the requested changes, please leave a comment on this pull request containing the phrase |
My understanding of this stuff, particularly on the Python side, is somewhat shallow, but from a discussion with @freakboy3742 it appears we can use crash reporters with Python signal handling overrides.
📚 Documentation preview 📚: https://cpython-previews--121881.org.readthedocs.build/