◐ Shell
reader mode source ↗
Skip to content

GH-89455: Add missing attributes (added in 3.11) to traceback module docs#105044

Merged
iritkatriel merged 13 commits into
python:mainfrom
Jackenmen:patch-1
May 29, 2023
Merged

GH-89455: Add missing attributes (added in 3.11) to traceback module docs#105044
iritkatriel merged 13 commits into
python:mainfrom
Jackenmen:patch-1

Conversation

@Jackenmen

@Jackenmen Jackenmen commented May 28, 2023 •
edited
Loading

Copy link
Copy Markdown
Contributor

It seems that exceptions have been missed when the exception groups were added in 3.11.

There are also two new parameters to TracebackException(...) - max_group_depth and max_group_width. I have only added the documentation for the parameters, not the attributes as modifying the latter wouldn't propagate the value to chained/grouped TracebackExceptions but I can add them if you wish.

I reused the issue number of the original issue that added these parameters/attributes.

I'm sorry for accidentally pinging so many people on #105043, GitHub doesn't warn you about the possibility of pinging people when changing the base :(
image

📚 Documentation preview 📚: https://cpython-previews--105044.org.readthedocs.build/

@Jackenmen Jackenmen requested a review from iritkatriel as a code owner May 28, 2023 19:03
@iritkatriel

iritkatriel commented May 28, 2023

Copy link
Copy Markdown
Member

I haven't created an issue for this because I figured it's just a documentation fix but I can create one if necessary.

We do create issues for documentation changes as well (unless trivial, as in typo).
In this case you could potentially attach this PR to the issue that added the fields you are documenting.

Jackenmen and others added 2 commits May 28, 2023 23:03
@Jackenmen
Remove 3.10 changes
d749737
@Jackenmen @iritkatriel
Apply suggestions from code review …
a9b7860 
Co-authored-by: Irit Katriel <1055913+iritkatriel@users.noreply.github.com>
@Jackenmen Jackenmen changed the title Add missing 3.10/11 attributes to traceback module docs May 28, 2023
@bedevere-bot bedevere-bot mentioned this pull request May 28, 2023
Closed
@iritkatriel iritkatriel added docs Documentation in the Doc dir needs backport to 3.11 only security fixes needs backport to 3.12 only security fixes labels May 28, 2023
@iritkatriel iritkatriel changed the title GH-89455: Add missing 3.11 attributes to traceback module docs May 29, 2023
@Jackenmen

Jackenmen commented May 29, 2023

Copy link
Copy Markdown
Contributor Author

Subinterpreters got hit by property-based tests, gonna retrigger the run

iritkatriel
iritkatriel approved these changes May 29, 2023
View reviewed changes

@iritkatriel iritkatriel 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.

Hide comment

Looks good, a few more minor suggestions.

@Jackenmen @iritkatriel
Apply suggestions from code review …
848ad94 
Co-authored-by: Irit Katriel <1055913+iritkatriel@users.noreply.github.com>
@iritkatriel iritkatriel enabled auto-merge (squash) May 29, 2023 18:13
@iritkatriel iritkatriel merged commit 39f6a04 into python:main May 29, 2023
@miss-islington

miss-islington commented May 29, 2023

Copy link
Copy Markdown
Contributor

Thanks @Jackenmen for the PR, and @iritkatriel for merging it 🌮🎉.. I'm working now to backport this PR to: 3.11, 3.12.
🐍🍒⛏🤖

@bedevere-bot

bedevere-bot commented May 29, 2023

Copy link
Copy Markdown

GH-105066 is a backport of this pull request to the 3.12 branch.

@bedevere-bot bedevere-bot removed the needs backport to 3.12 only security fixes label May 29, 2023
@bedevere-bot

bedevere-bot commented May 29, 2023

Copy link
Copy Markdown

GH-105067 is a backport of this pull request to the 3.11 branch.

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request May 29, 2023
@Jackenmen @miss-islington
pythonGH-89455: Add missing attributes (added in 3.11) to traceback m… …
0091b39 
…odule docs (pythonGH-105044)

(cherry picked from commit 39f6a04)

Co-authored-by: Jakub Kuczys <me@jacken.men>
@bedevere-bot bedevere-bot removed the needs backport to 3.11 only security fixes label May 29, 2023
@Jackenmen Jackenmen deleted the patch-1 branch May 29, 2023 18:29
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request May 29, 2023
@Jackenmen @miss-islington
pythonGH-89455: Add missing attributes (added in 3.11) to traceback m… …
a33343f 
…odule docs (pythonGH-105044)

(cherry picked from commit 39f6a04)

Co-authored-by: Jakub Kuczys <me@jacken.men>
iritkatriel pushed a commit that referenced this pull request May 29, 2023
@miss-islington @Jackenmen
[3.12] GH-89455: Add missing attributes (added in 3.11) to traceback … …
6794526 
…module docs (GH-105044) (#105066)

GH-89455: Add missing attributes (added in 3.11) to traceback module docs (GH-105044)
(cherry picked from commit 39f6a04)

Co-authored-by: Jakub Kuczys <me@jacken.men>
iritkatriel pushed a commit that referenced this pull request May 29, 2023
@miss-islington @Jackenmen
[3.11] GH-89455: Add missing attributes (added in 3.11) to traceback … …
c39500d 
…module docs (GH-105044) (#105067)

GH-89455: Add missing attributes (added in 3.11) to traceback module docs (GH-105044)
(cherry picked from commit 39f6a04)

Co-authored-by: Jakub Kuczys <me@jacken.men>
@bedevere-bot

This comment was marked as off-topic.

Sign in to view
@erlend-aasland erlend-aasland mentioned this pull request Jun 6, 2023
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@iritkatriel iritkatriel

Assignees

No one assigned

Labels

docs Documentation in the Doc dir

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@Jackenmen @iritkatriel @miss-islington @bedevere-bot