Skip to content

gh-69223: Document that add_argument() returns an Action object #145538

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.

Sign up for GitHub

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

Merged
savannahostrowski merged 3 commits into from
Mar 6, 2026
Merged

gh-69223: Document that add_argument() returns an Action object #145538

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3cf2eac
Doc: document add_argument() return value (Action object)
Bortlesboat Mar 5, 2026
8e7b16e
docs: simplify to document return type only per review
Bortlesboat Mar 6, 2026
d8a6e95
Merge branch 'main' into doc-argparse-add-argument-return
savannahostrowski Mar 6, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions Doc/library/argparse.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -698,6 +698,10 @@ The add_argument() method

* deprecated_ - Whether or not use of the argument is deprecated.

The method returns the :class:`Action` object that was created and added to
the parser. This can be stored and used for further customization or
inspection.

The following sections describe how each of these are used.


Expand Down
Loading