GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — gh-119580: Improve version added section for convenience variable by gaogaotiantian · Pull Request #119583 · python/cpython

Conversation

@gaogaotiantian

@gaogaotiantian gaogaotiantian commented May 26, 2024 •
edited by github-actions Bot
Loading

Uh oh!

There was an error while loading. Please reload this page.

Copy link
Copy Markdown
Member

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.

  • Issue: Cannot define global variables in .pdbrc #119580

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

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
@gaogaotiantian
Improve version added section for convenience variable
12bc2c5
@gaogaotiantian gaogaotiantian added skip news needs backport to 3.12 only security fixes needs backport to 3.13 only security fixes labels May 26, 2024
@bedevere-app bedevere-app Bot added docs Documentation in the Doc dir awaiting review labels May 26, 2024
@bedevere-app bedevere-app Bot mentioned this pull request May 26, 2024
Cannot define global variables in .pdbrc #119580
Closed
AlexWaygood
AlexWaygood reviewed May 26, 2024
View reviewed changes
Comment thread Doc/library/pdb.rst Outdated
* ``$_exception``: the exception if the frame is raising an exception

.. versionadded:: 3.12
.. versionadded:: 3.12 *convenience variable*

@AlexWaygood AlexWaygood May 26, 2024

Copy link
Copy Markdown
Member

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.

I think this is how we'd normally do this kind of thing:

Suggested change
.. 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

.. versionadded:: 3.6.2
Added :data:`NoReturn`.
.. versionadded:: 3.11
Added :data:`Never`.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions

@gaogaotiantian gaogaotiantian May 26, 2024

Copy link
Copy Markdown
Member Author

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.

Okay I copied the format from enum.rst where they do thing differently...

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions

@gaogaotiantian gaogaotiantian May 26, 2024

Copy link
Copy Markdown
Member Author

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.

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.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions

@AlexWaygood AlexWaygood May 27, 2024

Copy link
Copy Markdown
Member

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.

Okay I copied the format from enum.rst where 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

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
@gaogaotiantian
Change the format
b142593
AlexWaygood
AlexWaygood reviewed May 27, 2024
View reviewed changes
Comment thread Doc/library/pdb.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.
@gaogaotiantian @AlexWaygood
Update Doc/library/pdb.rst
e44bbca 
Co-authored-by: Alex Waygood <[email protected]>
AlexWaygood
AlexWaygood approved these changes May 27, 2024
View reviewed changes

@AlexWaygood AlexWaygood left a comment

Copy link
Copy Markdown
Member

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.

Thanks!

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
@bedevere-app bedevere-app Bot added awaiting merge and removed awaiting review labels May 27, 2024
@AlexWaygood
AlexWaygood enabled auto-merge (squash) May 27, 2024 17:22
@AlexWaygood
Merge branch 'main' into pdb-convenience-var-docs
690760c
@AlexWaygood
AlexWaygood merged commit 3dfa364 into python:main May 27, 2024
@miss-islington-app

miss-islington-app Bot commented May 27, 2024

Copy link
Copy Markdown

Thanks @gaogaotiantian for the PR, and @AlexWaygood for merging it 🌮🎉.. I'm working now to backport this PR to: 3.12, 3.13.
🐍🍒⛏🤖
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@bedevere-app bedevere-app Bot removed the awaiting merge label May 27, 2024
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request May 27, 2024
@gaogaotiantian @miss-islington
pythongh-119580: Improve version added section for convenience variab…
0ee7326 
…le (pythonGH-119583)

(cherry picked from commit 3dfa364)

Co-authored-by: Tian Gao <[email protected]>
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request May 27, 2024
@gaogaotiantian @miss-islington
pythongh-119580: Improve version added section for convenience variab…
7dfbce5 
…le (pythonGH-119583)

(cherry picked from commit 3dfa364)

Co-authored-by: Tian Gao <[email protected]>
@bedevere-app

bedevere-app Bot commented May 27, 2024

Copy link
Copy Markdown

GH-119624 is a backport of this pull request to the 3.13 branch.
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@bedevere-app bedevere-app Bot removed the needs backport to 3.13 only security fixes label May 27, 2024
@bedevere-app

bedevere-app Bot commented May 27, 2024

Copy link
Copy Markdown

GH-119625 is a backport of this pull request to the 3.12 branch.
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@bedevere-app bedevere-app Bot removed the needs backport to 3.12 only security fixes label May 27, 2024
AlexWaygood pushed a commit that referenced this pull request May 27, 2024
@miss-islington @gaogaotiantian
[3.12] gh-119580: Improve version added section for convenience varia…
823c66a 
…ble (GH-119583) (#119625)

Co-authored-by: Tian Gao <[email protected]>
AlexWaygood pushed a commit that referenced this pull request May 27, 2024
@miss-islington @gaogaotiantian
[3.13] gh-119580: Improve version added section for convenience varia…
9edf010 
…ble (GH-119583) (#119624)

Co-authored-by: Tian Gao <[email protected]>
@JelleZijlstra JelleZijlstra mentioned this pull request May 28, 2024
backport a9a74da 3.13 #119642
Closed
@gaogaotiantian
gaogaotiantian deleted the pdb-convenience-var-docs branch May 30, 2024 03:40
estyxx pushed a commit to estyxx/cpython that referenced this pull request Jul 17, 2024
@gaogaotiantian @estyxx
pythongh-119580: Improve version added section for convenience variab…
5e86c5e 
…le (python#119583)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@AlexWaygood AlexWaygood AlexWaygood approved these changes

Uh oh!

There was an error while loading. Please reload this page.

Assignees

No one assigned

Labels

docs Documentation in the Doc dir skip news

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Uh oh!

There was an error while loading. Please reload this page.

2 participants

@gaogaotiantian @AlexWaygood
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.