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-58058: Add quick reference for `ArgumentParser` to argparse docs by savannahostrowski · Pull Request #124227 · python/cpython

Conversation

@savannahostrowski

@savannahostrowski savannahostrowski commented Sep 18, 2024 •
edited by github-actions Bot
Loading

Uh oh!

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

Copy link
Copy Markdown
Member

This PR adds a quick reference table to the top of the argparse docs per #58058 (comment). I believe that this is the last item required before closing out this issue, since it looks like #91726 took care of adding a table for add_argument()

  • Issue: Summary tables for argparse add_argument options #58058

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

Sorry, something went wrong.

Uh oh!

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

All reactions
@savannahostrowski
add quick reference for ArgumentParser
8b61693
@savannahostrowski savannahostrowski added the docs Documentation in the Doc dir label Sep 18, 2024
@bedevere-app bedevere-app Bot added awaiting review skip news labels Sep 18, 2024
@bedevere-app bedevere-app Bot mentioned this pull request Sep 18, 2024
Summary tables for argparse add_argument options #58058
Closed
@savannahostrowski

savannahostrowski commented Sep 18, 2024

Copy link
Copy Markdown
Member Author

@ncoghlan, would you mind taking a look since you suggested adding this to the docs 😊 ?

All reactions

Sorry, something went wrong.

Uh oh!

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

savannahostrowski added 9 commits September 18, 2024 19:38
@savannahostrowski
fix warnings
45c4a44
@savannahostrowski
more formatting
5243c69
@savannahostrowski
remove test file;
e557c02
@savannahostrowski
newline
19bd061
@savannahostrowski
newline
3c90fc1
@savannahostrowski
remove indent
3920190
@savannahostrowski
remove macro
b1e5f76
@savannahostrowski
remove tilde
2000f32
@savannahostrowski
remove class
c1c9029
@CAM-Gerlach
CAM-Gerlach requested a review from ncoghlan September 20, 2024 20:43
@serhiy-storchaka
serhiy-storchaka requested a review from rhettinger September 23, 2024 09:44
@serhiy-storchaka

serhiy-storchaka commented Sep 23, 2024

Copy link
Copy Markdown
Member

I am not sure this is an improvement. This table just duplicates the bullet list in the ArgumentParser constructor documentation, but the bullet list is more compact. I think that the bullet list already addresses the initial request -- it is compact, contains one-line descriptions and links to more detailed documentation. The table is more bulky, contains a lot of blank space, descriptions do not fit in a single line, and the table do not fit in a single screen.

All reactions

Sorry, something went wrong.

Uh oh!

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

savannahostrowski added 2 commits September 23, 2024 17:18
@savannahostrowski
Address comments from rhettinger
7301095
@savannahostrowski
Merge branch 'main' into pythongh-58058
158fc56
@savannahostrowski

savannahostrowski commented Sep 24, 2024

Copy link
Copy Markdown
Member Author

@rhettinger Made the updates as we discussed! Let me know if you see anything else that needs updating.

All reactions

Sorry, something went wrong.

Uh oh!

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

@rhettinger
rhettinger merged commit 4e2fb7b into python:main Sep 25, 2024
@bedevere-app bedevere-app Bot removed the awaiting review label Sep 25, 2024
emilyemorehouse added a commit to lysnikolaou/cpython that referenced this pull request Sep 26, 2024
@emilyemorehouse
Merge branch 'main' into fix-help-double-prompt
4cdb3ae
* main: (69 commits)
  Add "annotate" SET_FUNCTION_ATTRIBUTE bit to dis. (python#124566)
  pythongh-124412: Add helpers for converting annotations to source format (python#124551)
  pythongh-119180: Disallow instantiation of ConstEvaluator objects (python#124561)
  For-else deserves its own section in the tutorial (python#123946)
  Add 3.13 as a version option to the crash issue template (python#124560)
  pythongh-123242: Note that type.__annotations__ may not exist (python#124557)
  pythongh-119180: Make FORWARDREF format look at __annotations__ first (python#124479)
  pythonGH-58058: Add quick reference for `ArgumentParser` to argparse docs (pythongh-124227)
  pythongh-41431: Add `datetime.time.strptime()` and `datetime.date.strptime()` (python#120752)
  pythongh-102450: Add ISO-8601 alternative for midnight to `fromisoformat()` calls. (python#105856)
  pythongh-124370: Add "howto" for free-threaded Python (python#124371)
  pythongh-121277: Allow `.. versionadded:: next` in docs (pythonGH-121278)
  pythongh-119400:  make_ssl_certs: update reference test data automatically, pass in expiration dates as parameters python#119400  (pythonGH-119401)
  pythongh-119180: Avoid going through AST and eval() when possible in annotationlib (python#124337)
  pythongh-124448: Update Windows builds to use Tcl/Tk 8.6.15 (pythonGH-124449)
  pythongh-123884 Tee of tee was not producing n independent iterators (pythongh-124490)
  pythongh-124378: Update test_ttk for Tcl/Tk 8.6.15 (pythonGH-124542)
  pythongh-124513: Check args in framelocalsproxy_new() (python#124515)
  pythongh-101100: Add a table of class attributes to the "Custom classes" section of the data model docs (python#124480)
  Doc: Use ``major.minor`` for documentation distribution archive filenames (python#124489)
  ...
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@ncoghlan ncoghlan Awaiting requested review from ncoghlan
@rhettinger rhettinger Awaiting requested review from rhettinger

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.

3 participants

@savannahostrowski @serhiy-storchaka @rhettinger
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.