Skip to content

gh-58032: Docs: Sort argparse alphabetically#125871

Merged
willingc merged 2 commits into
python:mainfrom
hugovk:docs-argparse-sort
Oct 30, 2024
Merged

gh-58032: Docs: Sort argparse alphabetically#125871
willingc merged 2 commits into
python:mainfrom
hugovk:docs-argparse-sort

Conversation

@hugovk

@hugovk hugovk commented Oct 23, 2024

Copy link
Copy Markdown
Member

Follow on from #124664, let's keep the modules sorted alphabetically.


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

@serhiy-storchaka serhiy-storchaka left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I intentionally moved builtins at the beginning of the list.

@savannahostrowski savannahostrowski left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks Hugo!

@willingc willingc left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚢

@willingc

Copy link
Copy Markdown
Contributor

I intentionally moved builtins at the beginning of the list.

@serhiy-storchaka What prompted you to move to the beginning? Perhaps we need a sentence or section break between them @hugovk

@serhiy-storchaka

Copy link
Copy Markdown
Member

Builtins look special to me, and in some other places we list them separately from other modules. I thought that even if we list them in the common list with other modules, it is worth to move the builtins module to the beginning. But I may be wrong here -- in few last What's New files (3.13, 3.14) they are listed alphabetically in the list of modules.

@willingc

Copy link
Copy Markdown
Contributor

Thanks for clarifying @serhiy-storchaka. @hugovk, do you want to offset built-ins from the rest of standard library modules?

@hugovk

hugovk commented Oct 25, 2024

Copy link
Copy Markdown
Member Author

In a way it's just another module in the docs, and I'd prefer alphabetical, but I don't mind too much.

If we're browsing a long list, it's easier to find alphabetically, and it'll be less likely for new edits to be added in arbitrary order if it begins with A instead of B.

cc @AA-Turner who edited the last two versions, any opinion?

@willingc

Copy link
Copy Markdown
Contributor

I'm going to go ahead and merge this to unblock the PR. We can always create future iterations to improve the difference between builtins and the other libraries.

@willingc willingc merged commit d4b6d84 into python:main Oct 30, 2024
@hugovk hugovk deleted the docs-argparse-sort branch October 30, 2024 06:40
picnixz pushed a commit to picnixz/cpython that referenced this pull request Dec 8, 2024
ebonnal pushed a commit to ebonnal/cpython that referenced this pull request Jan 12, 2025
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.

4 participants