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 — Update argparse `suggest_on_error` code snippet in docs by savannahostrowski · Pull Request #144985 · python/cpython

Conversation

@savannahostrowski

@savannahostrowski savannahostrowski commented Feb 19, 2026 •
edited
Loading

Uh oh!

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

Copy link
Copy Markdown
Member

The current example incorrectly shows integer literals in the parse_args() list (i.e., the code is actually invalid and results in a TypeError) and uses a confusing type=int conversion that isn't relevant to demonstrating suggest_on_error.

This PR simplifies the example to use realistic string choices without the unnecessary type conversion.

Reader's note: I was the one who originally added this example to the docs in #124456 🤦‍♀️

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

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
savannahostrowski added 2 commits February 18, 2026 20:59
@savannahostrowski
Update example to be clear, valid code.
eb42ddb
@savannahostrowski
Update return
71b9a1e
@savannahostrowski savannahostrowski added skip issue skip news needs backport to 3.14 bugs and security fixes labels Feb 19, 2026
@bedevere-app bedevere-app Bot added awaiting core review docs Documentation in the Doc dir labels Feb 19, 2026
@github-project-automation github-project-automation Bot added this to Docs PRs Feb 19, 2026
@github-project-automation github-project-automation Bot moved this to Todo in Docs PRs Feb 19, 2026
@savannahostrowski
Merge branch 'main' into update-example
9b691e3
@savannahostrowski
savannahostrowski enabled auto-merge (squash) February 23, 2026 17:19
@savannahostrowski
savannahostrowski merged commit 6194a55 into python:main Feb 23, 2026
29 checks passed

Uh oh!

There was an error while loading. Please reload this page.
@github-project-automation github-project-automation Bot moved this from Todo to Done in Docs PRs Feb 23, 2026
@miss-islington-app

miss-islington-app Bot commented Feb 23, 2026

Copy link
Copy Markdown

Thanks @savannahostrowski for the PR 🌮🎉.. I'm working now to backport this PR to: 3.14.
🐍🍒⛏🤖
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 core review label Feb 23, 2026
@miss-islington-app

miss-islington-app Bot commented Feb 23, 2026

Copy link
Copy Markdown

Sorry, @savannahostrowski, I could not cleanly backport this to 3.14 due to a conflict.
Please backport using cherry_picker on command line.

cherry_picker 6194a552f2b010e1dcdd006996f613c956520124 3.14
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@miss-islington-app miss-islington-app Bot assigned savannahostrowski Feb 23, 2026
savannahostrowski added a commit to savannahostrowski/cpython that referenced this pull request Feb 23, 2026
@savannahostrowski
Update argparse suggest_on_error code snippet in docs (python#144985)
7944ce2 
(cherry picked from commit 6194a55)
@bedevere-app

bedevere-app Bot commented Feb 23, 2026

Copy link
Copy Markdown

GH-145151 is a backport of this pull request to the 3.14 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.14 bugs and security fixes label Feb 23, 2026
@bedevere-app

bedevere-app Bot commented Feb 23, 2026

Copy link
Copy Markdown

GH-145151 is a backport of this pull request to the 3.14 branch.
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
savannahostrowski added a commit that referenced this pull request Feb 23, 2026
@savannahostrowski
[3.14] Update argparse suggest_on_error code snippet in docs (GH-14…
8b34bcc 
…4985) (#145151)

Update argparse `suggest_on_error` code snippet in docs (#144985)

(cherry picked from commit 6194a55)
brijkapadia pushed a commit to brijkapadia/cpython that referenced this pull request Feb 28, 2026
@savannahostrowski @brijkapadia
Update argparse suggest_on_error code snippet in docs (python#144985)
d9f4bc7
ljfp pushed a commit to ljfp/cpython that referenced this pull request Apr 25, 2026
@savannahostrowski @ljfp
Update argparse suggest_on_error code snippet in docs (python#144985)
77b5ce4
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Uh oh!

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

Assignees

@savannahostrowski savannahostrowski

Labels

docs Documentation in the Doc dir skip issue skip news

Projects

Docs PRs
Status: Done

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.

1 participant

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