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

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

Merged
merged 13 commits into from
May 29, 2023

Conversation

Jackenmen
Copy link
Contributor

@Jackenmen Jackenmen commented May 28, 2023

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/

Doc/library/traceback.rst Outdated Show resolved Hide resolved
Doc/library/traceback.rst Outdated Show resolved Hide resolved
Doc/library/traceback.rst Outdated Show resolved Hide resolved
@iritkatriel
Copy link
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
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 GH-89455: Add missing 3.11 attributes to traceback module docs May 28, 2023
Doc/library/traceback.rst Outdated Show resolved Hide resolved
Doc/library/traceback.rst Outdated Show resolved Hide resolved
@iritkatriel iritkatriel added docs Documentation in the Doc dir needs backport to 3.11 only security fixes needs backport to 3.12 bug and security fixes labels May 28, 2023
@iritkatriel iritkatriel changed the title GH-89455: Add missing 3.11 attributes to traceback module docs GH-89455: Add missing attributes (added in 3.11) to traceback module docs May 29, 2023
@Jackenmen
Copy link
Contributor Author

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

Copy link
Member

@iritkatriel iritkatriel left a comment

Choose a reason for hiding this comment

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

Looks good, a few more minor suggestions.

Doc/library/traceback.rst Outdated Show resolved Hide resolved
Lib/traceback.py Outdated Show resolved Hide resolved
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
Copy link
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
Copy link

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 bug and security fixes label May 29, 2023
@bedevere-bot
Copy link

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
…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
…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
…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
…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 up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation in the Doc dir
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants