Skip to content

Conversation

@sirosen
Copy link
Contributor

@sirosen sirosen commented Sep 27, 2025

Outside of titles and other contexts, convert this term to lowercase.
This usage better matches other terms defined in the packaging specifications, such as "script metadata" and "dependency specifiers".

For reference, this change was inspired by:
#1847 (comment)


I like having some kind of styling which indicates a term.
However, I would like to keep docs consistent. If there's some reasonable choice of styling (e.g., boldface) which can indicate a specialized term, I would be happy to work on applying it consistently across the site.


📚 Documentation preview 📚: https://python-packaging-user-guide--1918.org.readthedocs.build/en/1918/

@webknjaz
Copy link
Member

:term:`dependency groups`

on first use in a document, followed by italics in the following uses?

I recently discovered that CPython has a great style guide: https://devguide.python.org/documentation/style-guide/#links

@webknjaz
Copy link
Member

@sirosen time to rebase?

@sirosen
Copy link
Contributor Author

sirosen commented Oct 17, 2025

I'll rebase happily when I have some downtime. I'm currently traveling, very limited availability.

I wasn't clear, btw, if your reference to the Python docs style guide was a request for changes. I'm happy to start using a new style. But I think that would need buy in from other maintainers -- which in my mind means @ncoghlan, unless there are others I don't know about? If the two of you agree on some desired style for technical terms, based on the Python one or otherwise, I'm happy to not only apply it here but also try to make all of the pages uniform in using it.

@webknjaz
Copy link
Member

@sirosen oh, I forgot you're afk for a while.. I'll accept it as is for now.

I did want to follow the CPython guide but you're right, it can be handled separately.

Outside of titles and other contexts, convert this term to lowercase.
This usage better matches other terms defined in the packaging
specifications, such as "script metadata" and "dependency specifiers".

For reference, this change was inspired by:
pypa#1847 (comment)
@webknjaz webknjaz force-pushed the improve-case-consistency-dependency-groups branch from 174e3c1 to 1700f85 Compare October 17, 2025 07:43
@webknjaz webknjaz enabled auto-merge October 17, 2025 07:43
@webknjaz webknjaz added this pull request to the merge queue Oct 17, 2025
Merged via the queue into pypa:main with commit bdda06f Oct 17, 2025
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants