8000 Improve formatting of the argparse documentation · Issue #126071 · python/cpython · GitHub
[go: up one dir, main page]
Skip to content

Improve formatting of the argparse documentation #126071

New issue

Have a question about this project? Sign up for a free GitHub ac 8000 count 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

Jump to bottom
Closed
serhiy-storchaka opened this issue Oct 28, 2024 · 0 comments
Closed

Improve formatting of the argparse documentation #126071

serhiy-storchaka opened this issue Oct 28, 2024 · 0 comments
Labels
3.12 only security fixes 3.13 bugs and security fixes 3.14 bugs and security fixes docs Documentation in the Doc dir

Comments

@serhiy-storchaka
Copy link
Member
serhiy-storchaka commented Oct 28, 2024 •
edited by bedevere-app bot
Loading

The proposed PR improves formatting of the argparse documentation.

  • Use appropriate roles for ArgumentParser, Action, etc.
  • Remove superfluous repeated links.
  • Explicitly document signatures and add index entries for some methods and classes.
  • Make it more clear that some parameters are keyword-only.
  • Fix some minor errors.

Linked PRs
@serhiy-storchaka serhiy-storchaka added docs Documentation in the Doc dir 3.12 only security fixes 3.13 bugs and security fixes 3.14 bugs and security fixes labels Oct 28, 2024
@serhiy-storchaka serhiy-storchaka moved this to Doc issues in Argparse issues Oct 28, 2024
serhiy-storchaka added a commit to serhiy-storchaka/cpython that referenced this issue Oct 28, 2024
@serhiy-storchaka
pythongh-126071: Improve formatting of the argparse documentation
c52e8cd 
* Use appropriate roles for ArgumentParser, Action, etc.
* Remove superfluous repeated links.
* Explicitly document signatures and add index entries for some methods
  and classes.
* Make it more clear that some parameters are keyword-only.
* Fix some minor errors.
@bedevere-app bedevere-app bot mentioned this issue Oct 28, 2024
Merged
serhiy-storchaka added a commit that referenced this issue Oct 30, 2024
@serhiy-storchaka
gh-126071: Improve formatting of the argparse documentation (GH-126073)
2ab377a 
* Use appropriate roles for ArgumentParser, Action, etc.
* Remove superfluous repeated links.
* Explicitly document signatures and add index entries for some methods
  and classes.
* Make it more clear that some parameters are keyword-only.
* Fix some minor errors.
@bedevere-app bedevere-app bot mentioned this issue Oct 30, 2024
Merged
serhiy-storchaka added a commit to serhiy-storchaka/cpython that referenced this issue Oct 30, 2024
@serhiy-storchaka
[3.13] pythongh-126071: Improve formatting of the argparse documentat…
40af11b 
…ion (pythonGH-126073)

* Use appropriate roles for ArgumentParser, Action, etc.
* Remove superfluous repeated links.
* Explicitly document signatures and add index entries for some methods
  and classes.
* Make it more clear that some parameters are keyword-only.
* Fix some minor errors.
(cherry picked from commit 2ab377a)

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
serhiy-storchaka added a commit to serhiy-storchaka/cpython that referenced this issue Oct 30, 2024
@serhiy-storchaka
[3.12] pythongh-126071: Improve formatting of the argparse documentat…
183c2da 
…ion (pythonGH-126073)

* Use appropriate roles for ArgumentParser, Action, etc.
* Remove superfluous repeated links.
* Explicitly document signatures and add index entries for some methods
  and classes.
* Make it more clear that some parameters are keyword-only.
* Fix some minor errors.
(cherry picked from commit 2ab377a)

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
@bedevere-app bedevere-app bot mentioned this issue Oct 30, 2024
Merged
serhiy-storchaka added a commit that referenced this issue Oct 30, 2024
@serhiy-storchaka
[3.12] gh-126071: Improve formatting of the argparse documentation (G…
b4040c4 
…H-126073) (GH-126174)

* Use appropriate roles for ArgumentParser, Action, etc.
* Remove superfluous repeated links.
* Explicitly document signatures and add index entries for some methods
  and classes.
* Make it more clear that some parameters are keyword-only.
* Fix some minor errors.
(cherry picked from commit 2ab377a)
serhiy-storchaka added a commit that referenced this issue Oct 30, 2024
@serhiy-storchaka
[3.13] gh-126071: Improve formatting of the argparse documentation (G…
6b0ef1f 
…H-126073) (GH-126173)

* Use appropriate roles for ArgumentParser, Action, etc.
* Remove superfluous repeated links.
* Explicitly document signatures and add index entries for some methods
  and classes.
* Make it more clear that some parameters are keyword-only.
* Fix some minor errors.
(cherry picked from commit 2ab377a)
picnixz pushed a commit to picnixz/cpython that referenced this issue Dec 8, 2024
@serhiy-storchaka @picnixz
pythongh-126071: Improve formatting of the argparse documentation (py…
127319e 
…thonGH-126073)

* Use appropriate roles for ArgumentParser, Action, etc.
* Remove superfluous repeated links.
* Explicitly document signatures and add index entries for some methods
  and classes.
* Make it more clear that some parameters are keyword-only.
* Fix some minor errors.
ebonnal pushed a commit to ebonnal/cpython that referenced this issue Jan 12, 2025
@serhiy-storchaka @ebonnal
pythongh-126071: Improve formatting of the argparse documentation (py…
add3671 
…thonGH-126073)

* Use appropriate roles for ArgumentParser, Action, etc.
* Remove superfluous repeated links.
* Explicitly document signatures and add index entries for some methods
  and classes.
* Make it more clear that some parameters are keyword-only.
* Fix some minor errors.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
3.12 only security fixes 3.13 bugs and security fixes 3.14 bugs and security fixes docs Documentation in the Doc dir
Projects
Argparse issues
Status: Doc issues
Milestone
No milestone
Development

No branches or pull requests
1 participant
@serhiy-storchaka
0