WebSafe 3.7github.com
|
|
🏠
Skip to content

GH-58058: Add quick reference for ArgumentParser to argparse docs#124227

Merged
rhettinger merged 12 commits intopython:mainfrom
savannahostrowski:gh-58058
Sep 25, 2024
Merged

GH-58058: Add quick reference for ArgumentParser to argparse docs#124227
rhettinger merged 12 commits intopython:mainfrom
savannahostrowski:gh-58058

Conversation

@savannahostrowski
Copy link
Member

@savannahostrowski savannahostrowski commented Sep 18, 2024

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()


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

@savannahostrowski
Copy link
Member Author

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

@serhiy-storchaka
Copy link
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.

@savannahostrowski
Copy link
Member Author

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

@rhettinger rhettinger merged commit 4e2fb7b into python:main Sep 25, 2024
emilyemorehouse added a commit to lysnikolaou/cpython that referenced this pull request Sep 26, 2024
* 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

Labels

docs Documentation in the Doc dir skip news

3 participants

Comments