gh-84116: Docs: Document help and aliases for argparse.add_parser() by Krishna-web-hub · Pull Request #140574 · python/cpython

Krishna-web-hub · 2025-10-25T09:47:46Z

gh-84116: Doc: update the argparse documentation to clearly define the help and aliases parameters for add_parser() and added the required news file for this change.

Doc/library/argparse.rst

Replaced the vague, single-sentence description of _SubParsersAction.add_parser with a formal .. method:: directive.

This new directive explicitly lists help and aliases as parameters, along with descriptions of what they do.

Removed the old, redundant paragraphs about help (which was in parentheses) and aliases (which was a "Furthermore..." note) from later in the document. This centralizes all the information in one logical place.

Misc/NEWS.d/next/Library/...

Added the required "blurb" file to log this documentation fix.

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

…python into doc-fix-140281

…4116)

StanFromIreland

There seem to be two different things mixed in this PR, please split it.

Krishna-web-hub · 2026-01-16T20:15:58Z

Thanks @picnixz , for your effort for correcting me, for the mistake i am making. And i am very sorry for being impatient. I will keep it in my mind. And i was just being confused as it is sort of new for me, but i never want to disrespect you.

picnixz

Some final comments. Otherwise I think we can merge it.

Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>

Krishna-web-hub · 2026-01-18T06:31:56Z

@picnixz Added all the changes you have requested for.

picnixz · 2026-01-19T02:18:25Z

+ >>> parser = argparse.ArgumentParser(prog='chicken.py')
+ >>> subparsers = parser.add_subparsers()
+ >>> fly = subparsers.add_parser('fly', deprecated=True)
+ >>> args = parser.parse_args(['fly']) # doctest: +SKIP


Can you remove the doctest skip? and write down the exact output so that we also catch message regressions just in case? ty

Hi @picnixz , Even after removing the # doctest: +SKIP the document does not produce the warning. so if you want i can remove the warning line below.

If the warning line is not emitted that is a bit weird. Is the warning emitted with the REPL?

@picnixz i am able to produce the warning now
the warning goes by
chicken.py: warning: command 'fly' is deprecated
Namespace()
so i will be adding exactly the same or not.

This has still not be changed. I want you to remove the skip and match the message correctly..

I was just updating my branch here i have added the changes you requested.

picnixz · 2026-01-19T02:20:18Z

(Btw the major changes I requested are addressed so this is in a mergeable state should I say).

Changes were addressed.

Krishna-web-hub · 2026-02-02T04:28:45Z

Hello @savannahostrowski the previous issue of two commit is being merged due to some issue in the branch and the documentation of free threading is merged in pr #140566. So if you please review the whole commit of this pr and tell me what else you need I can work according to it.

Krishna-web-hub · 2026-02-02T04:32:06Z

Hello @StanFromIreland The commits are already splited. please check out the changes done and tell me what else you need to be changed in the documentation

savannahostrowski · 2026-02-06T21:28:52Z

Oops, I forgot to officially hit the approve button after reviewing this/before merging, that's my bad. I think we should close this one out and tackle any minor follow ups etc. in other PRs since this has been ongoing for quite awhile.

Thanks a lot for all the back and forth here @picnixz! Much appreciated.

hugovk · 2026-02-06T22:57:46Z

Tip for next time, let's try and avoid listing all the cleanup commits in the squashed message, but keep the Co-authored-by trailers at the end:

74db440

(I use Refined GitHub which usually clears all that out.)

Thanks!

savannahostrowski · 2026-02-06T23:00:11Z

Ah yeah, I forgot to do that too. I typically remember but I guess I'm just off my game today. Sorry!

guoci · 2026-02-07T17:44:12Z

 the main parser.


+.. method:: _SubParsersAction.add_parser(name, *, help=None, aliases=None,


Missing backslash, fixed at #144572.

@picnixz

…er() (python#140574) * pythongh-140281: Doc: Update free-threading how-to * pythongh-140281: Doc: Update free-threading how-to * Fix trailing whitespace * doc fixing of the cpython fixes#84116 * Docs: Document help and aliases for argparse.add_parser() (pythongh-84116) * Docs: Document help and aliases for argparse.add_parser() (pythongh-84116) * Fix trailing whitespace * Fix trailing whitespace * Fix trailing whitespace * Fix trailing whitespace * Fix trailing whitespace * Fix trailing whitespace * Fix trailing errors * Fix trailing errors and spaces * Fix docutils formatting, NEWS ref, and trailing whitespace * Docs: Update argparse.rst and add NEWS entry * Delete Doc/howto/free-threading-python.rst * Delete Misc/NEWS.d/next/Documentation/2025-10-25-00-49-43.gh-issue-140281.tuMQUe.rst * adding the depreceated tag * The error indexing was fixed * Fix trailing whitespace * Restore missing free-threading documentation * fixing some minor error * fixing some minor error part 2 * fixing some minor error part 3 * Fix NEWS entry format * Final cleanup of NEWS entry format 2 * changes in the argparse.rst * Remove unnecessary NEWS entry * Fixing the issue as requested * Added the Changes done before. * done the changes * done the changes#1 * Apply suggestion from @picnixz Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com> * Apply suggestion from @picnixz Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com> * Done the changes * Done the new changes * The versionadded is rectified * Update Doc/library/argparse.rst Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com> * Docs editing * Docs fixing whitespace * Docs rectifiying * little bit rectification * Indentation rectification * Indentation rectification 1 * Apply suggestion from @picnixz Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com> * deprecated rectification * Remove mistakenly added NEWS entry * Update Doc/library/argparse.rst Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com> * changes python#1 Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com> * Update Doc/library/argparse.rst 2 Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com> * removed useless thing Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com> * changed according to the request Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com> * Updated the test part --------- Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com> Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>

@picnixz

…er() (python#140574) * pythongh-140281: Doc: Update free-threading how-to * pythongh-140281: Doc: Update free-threading how-to * Fix trailing whitespace * doc fixing of the cpython fixes#84116 * Docs: Document help and aliases for argparse.add_parser() (pythongh-84116) * Docs: Document help and aliases for argparse.add_parser() (pythongh-84116) * Fix trailing whitespace * Fix trailing whitespace * Fix trailing whitespace * Fix trailing whitespace * Fix trailing whitespace * Fix trailing whitespace * Fix trailing errors * Fix trailing errors and spaces * Fix docutils formatting, NEWS ref, and trailing whitespace * Docs: Update argparse.rst and add NEWS entry * Delete Doc/howto/free-threading-python.rst * Delete Misc/NEWS.d/next/Documentation/2025-10-25-00-49-43.gh-issue-140281.tuMQUe.rst * adding the depreceated tag * The error indexing was fixed * Fix trailing whitespace * Restore missing free-threading documentation * fixing some minor error * fixing some minor error part 2 * fixing some minor error part 3 * Fix NEWS entry format * Final cleanup of NEWS entry format 2 * changes in the argparse.rst * Remove unnecessary NEWS entry * Fixing the issue as requested * Added the Changes done before. * done the changes * done the changes#1 * Apply suggestion from @picnixz Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com> * Apply suggestion from @picnixz Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com> * Done the changes * Done the new changes * The versionadded is rectified * Update Doc/library/argparse.rst Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com> * Docs editing * Docs fixing whitespace * Docs rectifiying * little bit rectification * Indentation rectification * Indentation rectification 1 * Apply suggestion from @picnixz Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com> * deprecated rectification * Remove mistakenly added NEWS entry * Update Doc/library/argparse.rst Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com> * changes python#1 Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com> * Update Doc/library/argparse.rst 2 Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com> * removed useless thing Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com> * changed according to the request Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com> * Updated the test part --------- Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com> Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>

Krishna-web-hub added 6 commits October 24, 2025 20:55

pythongh-140281: Doc: Update free-threading how-to
810fde1

pythongh-140281: Doc: Update free-threading how-to
b9ca059

Merge branch 'main' into doc-fix-140281
bfbf864

Fix trailing whitespace
16a1c46

Merge branch 'doc-fix-140281' ofhttps://github.com/Krishna-web-hub/c…
639865d
…python into doc-fix-140281

doc fixing of the cpython fixes#84116
3f0aa48

Krishna-web-hub requested a review from savannahostrowski as a code owner October 25, 2025 09:47

bedevere-appBot added the docs Documentation in the Doc dir label Oct 25, 2025

github-project-automationBot added this to Docs PRs Oct 25, 2025

bedevere-appBot mentioned this pull request Oct 25, 2025
argparse: help parameter not documented in add_subparsers().add_parser #84116
Closed

bedevere-appBot added the awaiting review label Oct 25, 2025

github-project-automationBot moved this to Todo in Docs PRs Oct 25, 2025

Docs: Document help and aliases for argparse.add_parser() (pythongh-8…
343648b
…4116)

Krishna-web-hub force-pushed the doc-fix-84116 branch from 57a35b9 to 343648bCompare October 25, 2025 10:16

StanFromIreland changed the title ~~Doc fix 84116Docs: Document help and aliases for argparse.add_parser() (gh-84116) #84116~~gh-84116: Docs: Document help and aliases for argparse.add_parser()Oct 25, 2025

Docs: Document help and aliases for argparse.add_parser() (pythongh-8…
4b07ba3
…4116)

StanFromIreland requested changes Oct 25, 2025
View reviewed changes

bedevere-appBot added awaiting core review and removed awaiting review labels Oct 25, 2025

Krishna-web-hub added 9 commits October 25, 2025 16:16

Fix trailing whitespace
8bb4bae

Fix trailing whitespace
3361447

Fix trailing whitespace
100207d

Fix trailing whitespace
0f27e63

Fix trailing whitespace
7e6102a

Fix trailing whitespace
a76954c

Fix trailing errors
ac2b754

Fix trailing errors and spaces
b08e8ed

Fix docutils formatting, NEWS ref, and trailing whitespace
fa1d877

Krishna-web-hub force-pushed the doc-fix-84116 branch from ce36e2d to 10dffc6Compare October 25, 2025 13:52

Docs: Update argparse.rst and add NEWS entry
e955fb0

Krishna-web-hub added 2 commits January 17, 2026 01:46

Merge branch 'main' into doc-fix-84116
2e7f2b0

Merge branch 'main' into doc-fix-84116
e3e5071

picnixz reviewed Jan 18, 2026
View reviewed changes

Comment threadDoc/library/argparse.rst Outdated
Comment threadDoc/library/argparse.rst Outdated
Comment threadDoc/library/argparse.rst Outdated
Comment threadDoc/library/argparse.rst Outdated
Comment threadDoc/library/argparse.rst Outdated

Krishna-web-huband others added 5 commits January 18, 2026 11:41

Update Doc/library/argparse.rst
b6975a7
Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>

changespython#1
04a0482
Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>

Update Doc/library/argparse.rst 2
0d4fcb5
Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>

removed useless thing
7d3982f
Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>

changed according to the request
b2ff463
Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>

Merge branch 'main' into doc-fix-84116
5709cc6

picnixz reviewed Jan 19, 2026
View reviewed changes

picnixz added awaiting core review and removed awaiting changes labels Jan 19, 2026

Krishna-web-hub added 2 commits February 3, 2026 15:06

Merge branch 'main' into doc-fix-84116
bc50109

Updated the test part
c69d057

savannahostrowski merged commit 74db440 into python:mainFeb 6, 2026
29 checks passed

github-project-automationBot moved this from Todo to Done in Docs PRs Feb 6, 2026

bedevere-appBot removed the awaiting core review label Feb 6, 2026

guoci reviewed Feb 7, 2026
View reviewed changes

Krishna-web-hub deleted the doc-fix-84116 branch February 7, 2026 19:04

		the main parser.


		.. method:: _SubParsersAction.add_parser(name, *, help=None, aliases=None,

Uh oh!

Uh oh!

Conversation

Krishna-web-hub commented Oct 25, 2025• edited by github-actions BotLoading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

StanFromIreland left a comment

Choose a reason for hiding this comment

Uh oh!

Krishna-web-hub commented Jan 16, 2026• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

picnixz left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Krishna-web-hub commented Jan 18, 2026

Uh oh!

Uh oh!

picnixzJan 19, 2026

Choose a reason for hiding this comment

Uh oh!

Krishna-web-hubFeb 1, 2026

Choose a reason for hiding this comment

Uh oh!

picnixzFeb 1, 2026

Choose a reason for hiding this comment

Uh oh!

Krishna-web-hubFeb 1, 2026

Choose a reason for hiding this comment

Uh oh!

picnixzFeb 3, 2026• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Krishna-web-hubFeb 3, 2026

Choose a reason for hiding this comment

Uh oh!

picnixz commented Jan 19, 2026

Uh oh!

Krishna-web-hub commented Feb 2, 2026

Uh oh!

Krishna-web-hub commented Feb 2, 2026• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

savannahostrowski commented Feb 6, 2026• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

hugovk commented Feb 6, 2026

Uh oh!

savannahostrowski commented Feb 6, 2026

Uh oh!

guociFeb 7, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

8 participants

Krishna-web-hub commented Oct 25, 2025•
edited by github-actions Bot
Loading

Krishna-web-hub commented Jan 16, 2026•
edited
Loading

picnixzFeb 3, 2026•
edited
Loading

Krishna-web-hub commented Feb 2, 2026•
edited
Loading

savannahostrowski commented Feb 6, 2026•
edited
Loading