Skip to content
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

gh-85453: Improve variable mark up on datetime.rst #120702

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

uatach
Copy link
Contributor

@uatach uatach commented Jun 18, 2024

Another pull request based on PR #21447, this one focused on improving variable mark up.


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

@@ -1213,7 +1213,7 @@ Supported operations:

If both are naive, or both are aware and have the same :attr:`~.datetime.tzinfo` attribute,
the :attr:`~.datetime.tzinfo` attributes are ignored, and the result is a :class:`timedelta`
object *t* such that ``datetime2 + t == datetime1``. No time zone adjustments
object ``t`` such that ``datetime2 + t == datetime1``. No time zone adjustments
Copy link
Contributor Author

Choose a reason for hiding this comment

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

@erlend-aasland I've found several occurrences like these, they don't seem to be method or function parameters like you said in #85453 (comment), but I'm not sure if they should all be marked up as variables.

Copy link
Contributor

Choose a reason for hiding this comment

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

I think these fall in the variables/literals/code category of our style guide:

https://devguide.python.org/documentation/markup/#quick-reference

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
awaiting review docs Documentation in the Doc dir skip news
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants