Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

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

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.

By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

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

Conversation

savannahostrowski
Copy link
Member

@savannahostrowskisavannahostrowski commentedSep 18, 2024
edited by github-actionsbot
Loading

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


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

@savannahostrowski
Copy link
MemberAuthor

@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 theArgumentParser 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
MemberAuthor

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

@rhettingerrhettinger merged commit4e2fb7b intopython:mainSep 25, 2024
37 checks passed
emilyemorehouse added a commit to lysnikolaou/cpython that referenced this pull requestSep 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 parameterspython#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 freeto join this conversation on GitHub. Already have an account?Sign in to comment
Reviewers

@ncoghlanncoghlanAwaiting requested review from ncoghlan

@rhettingerrhettingerAwaiting requested review from rhettinger

Assignees
No one assigned
Labels
docsDocumentation in the Doc dirskip news
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

3 participants
@savannahostrowski@serhiy-storchaka@rhettinger

[8]ページ先頭

©2009-2025 Movatter.jp