gh-119580: Improve version added section for convenience variable #119583
Conversation
gaogaotiantian
added
skip news
needs backport to 3.12
Doc/library/pdb.rst
Outdated
| @@ -288,7 +288,7 @@ There are three preset *convenience variables*: | |||
| * ``$_retval``: the return value if the frame is returning | |||
| * ``$_exception``: the exception if the frame is raising an exception | |||
|
|
|||
| .. versionadded:: 3.12 | |||
| .. versionadded:: 3.12 *convenience variable* | |||
There was a problem hiding this comment.
I think this is how we'd normally do this kind of thing:
| .. versionadded:: 3.12 *convenience variable* | |
| .. versionadded:: 3.12 | |
| Added the three convenience variables |
E.g. see
cpython/Doc/library/typing.rst
Lines 891 to 897 in 5d04cc5
There was a problem hiding this comment.
Okay I copied the format from enum.rst where they do thing differently...
There was a problem hiding this comment.
Also this is what confused the user - we did not only add the three convenience variables, we added the convenience variable feature, together with three pre-defined convenience variables.
There was a problem hiding this comment.
Okay I copied the format from
enum.rstwhere they do thing differently...
Oh, fair enough!
Also this is what confused the user - we did not only add the three convenience variables, we added the convenience variable feature, together with three pre-defined convenience variables.
I see. I think your proposed text is maybe slightly too terse in that case; I still misread it as a non-pdb expert
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
|
Thanks @gaogaotiantian for the PR, and @AlexWaygood for merging it 🌮🎉.. I'm working now to backport this PR to: 3.12, 3.13. |
…le (pythonGH-119583) (cherry picked from commit 3dfa364) Co-authored-by: Tian Gao <gaogaotiantian@hotmail.com>
…le (pythonGH-119583) (cherry picked from commit 3dfa364) Co-authored-by: Tian Gao <gaogaotiantian@hotmail.com>
|
GH-119624 is a backport of this pull request to the 3.13 branch. |
|
GH-119625 is a backport of this pull request to the 3.12 branch. |
The version added section is not clear about what is "added" because there are a lot of content above. Clarify it by explicitly write the feature.
📚 Documentation preview 📚: https://cpython-previews--119583.org.readthedocs.build/