FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

bpo-45292: [PEP-654] exception groups and except* documentation by iritkatriel · Pull Request #30158 · python/cpython · GitHub

/ cpython Public

bpo-45292: [PEP-654] exception groups and except* documentation - #30158

Merged
iritkatriel merged 17 commits into
python:mainfrom
iritkatriel:bpo-45292-doc
Jan 6, 2022
Merged

bpo-45292: [PEP-654] exception groups and except* documentation#30158
iritkatriel merged 17 commits into
python:mainfrom
iritkatriel:bpo-45292-doc

Conversation

iritkatriel commented Dec 16, 2021
edited by bedevere-bot
Loading

Copy link
Copy Markdown
Member

Copy link
Copy Markdown
Member Author

@willingc Is there anyone from the documentation experts who may be interested in helping with this?

iritkatriel changed the title bpo-45292: except* documentation bpo-45292: [PEP-654] exception groups and except* documentation Dec 16, 2021

Copy link
Copy Markdown
Member

@Fidget-Spinner Are you available to help here?

Copy link
Copy Markdown
Contributor

@iritkatriel I'm happy to help if @Fidget-Spinner is unavailable. I'm assuming you wish for some help to resolve whatever is causing the doc build to error.

willingc left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Irit, this looks good. Looking into the keyword errors.

Comment thread Doc/library/exceptions.rst Outdated
Comment thread Doc/library/exceptions.rst Outdated
Comment thread Doc/library/exceptions.rst Outdated
Comment thread Doc/reference/compound_stmts.rst Outdated

Copy link
Copy Markdown
Member Author

@iritkatriel I'm happy to help if @Fidget-Spinner is unavailable. I'm assuming you wish for some help to resolve whatever is causing the doc build to error.

Thank you. Not just the formatting error, also a fresh reader who can see if it’s clear and consistent with the documentation style, and whether things are where they belong and at the right level of detail.

Co-authored-by: Carol Willing <carolcode@willingconsulting.com>

Copy link
Copy Markdown
Contributor

@iritkatriel I think the tone and content are well done. I need to drop for the evening but feel free to merge if the build error resolves. Ping me in the morning if you get stuck on that. Thanks!

Fidget-Spinner commented Dec 17, 2021
edited
Loading

Copy link
Copy Markdown
Member

Hi @iritkatriel, you need to create a label/anchor (I forgot the term) for except_star. See line 221-223 of compound_stmts.rst for an example. Adding a .._except_star: under the try, except, finally labels should be sufficient.

For some reason, keyword labels must be placed preceding a title, even though rST supports arbitrary anchors normally. See https://www.sphinx-doc.org/en/master/usage/restructuredtext/roles.html#role-ref for more info.

Copy link
Copy Markdown
Member Author

Thank you @willingc and @Fidget-Spinner , it's looking good now.

I will give @gvanrossum and @1st1 and anyone else a chance to review before merging. There isn't any rush with this - the early users we have now already read the PEP.

Fidget-Spinner left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Wow! This is the first time I'm reading about PEP 654 in more detail, and I did not realize it was this powerful!

Speaking from the perspective of a newbie, I understood what you wrote. The tutorial and language reference is very clear to me.

Comment thread Doc/library/exceptions.rst Outdated
Comment thread Doc/library/exceptions.rst Outdated
Co-authored-by: Kumar Aditya <59607654+kumaraditya303@users.noreply.github.com>
Comment thread Doc/tutorial/errors.rst
Comment thread Doc/reference/compound_stmts.rst Outdated
Comment thread Doc/tutorial/errors.rst
Comment thread Doc/reference/compound_stmts.rst Outdated
Co-authored-by: Kumar Aditya <59607654+kumaraditya303@users.noreply.github.com>
Comment thread Doc/library/exceptions.rst Outdated
Comment thread Doc/library/exceptions.rst Outdated
Comment thread Doc/library/exceptions.rst Outdated
Comment thread Doc/library/traceback.rst Outdated
Comment thread Doc/tutorial/errors.rst
Comment thread Doc/tutorial/errors.rst Outdated
iritkatriel and others added 3 commits December 20, 2021 19:56
Co-authored-by: Kumar Aditya <59607654+kumaraditya303@users.noreply.github.com>

Zac-HD commented Dec 21, 2021

Copy link
Copy Markdown
Contributor

I'm happy to take comments related to .__note__ over on my PEP 678 draft 😁

Copy link
Copy Markdown
Member Author

Shall I merge this? It might be nice to have the documentation there when except* is released in the next alpha.

willingc commented Jan 6, 2022

Copy link
Copy Markdown
Contributor

@iritkatriel Prior to merging, can you recap any outstanding next actions needed in a message here. Thanks!

iritkatriel commented Jan 6, 2022
edited
Loading

Copy link
Copy Markdown
Member Author

I believe this PR now describes the way exception groups and except* work, and is consistent with PEP654.

The new __note__ field on exception is the subject of PEP678, which is still in draft stage. The doc here describes the current implementation, which is consistent with the PEP. Any changes/reversion following the PEP678 discussions will be made in the code and the doc at the same time.

Copy link
Copy Markdown
Member Author

I could also split out the __note__ section into a separate PR and merge only the PEP654 stuff for now if that works better.

Copy link
Copy Markdown
Member

I could also split out the __note__ section into a separate PR and merge only the PEP654 stuff for now if that works better.

Yeah, let's keep __note__ undocumented until its PEP has been approved.

Comment thread Doc/tutorial/errors.rst Outdated
iritkatriel merged commit 9925e70 into python:main Jan 6, 2022
iritkatriel deleted the bpo-45292-doc branch January 6, 2022 19:22

Copy link
Copy Markdown
Member Author

Thank you everyone!

The notes section is in this draft PR #30441.

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

Labels

docs Documentation in the Doc dir skip news

Projects

None yet

Development

Successfully merging this pull request may close these issues.


Back | FazBrowse Home | New Git URL