Skip to content

[3.13] gh-126071: Improve formatting of the argparse documentation (GH-126073) #126173

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 our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged

Conversation

serhiy-storchaka
Copy link
Member

@serhiy-storchaka serhiy-storchaka commented Oct 30, 2024

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


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

…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 <[email protected]>
@bedevere-app bedevere-app bot added docs Documentation in the Doc dir skip news labels Oct 30, 2024
@serhiy-storchaka serhiy-storchaka enabled auto-merge (squash) October 30, 2024 09:01
@serhiy-storchaka serhiy-storchaka merged commit 6b0ef1f into python:3.13 Oct 30, 2024
30 checks passed
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant