gh-141984: Reword and reorganize the first part of Atoms docs #144117
+167
−51
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Co-authored-by: Blaise Pabon <blaise@gmail.com>
| occurrence) may obtain the same object or a different object with the same | ||
| value. | ||
|
|
||
| .. admonition:: CPython implementation detail |
Member
There was a problem hiding this comment.
Why not .. impl-detail::?
Member
Author
There was a problem hiding this comment.
It's hard to see where .. impl-detail:: ends, which is crucial in this case. The paragraph on Template strings logically follows this information, but is not an implementation detail any more.
Member
There was a problem hiding this comment.
I see, that makes sense. I wonder why .. impl-detail:: doesn’t create an admonition but rather just bold text...?
Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
StanFromIreland
approved these changes
Feb 11, 2026
Member
StanFromIreland
left a comment
StanFromIreland
left a comment
There was a problem hiding this comment.
Two little notes but otherwise LGTM :-)
| :ref:`grammar notation <notation>` will be used to describe syntax, | ||
| not lexical analysis. | ||
|
|
||
| When (one alternative of) a syntax rule has the form |
Member
There was a problem hiding this comment.
Suggested change
| When (one alternative of) a syntax rule has the form | |
| When (one alternative of) a syntax rule has the form: |
| * if either argument is a complex or a floating-point number, the other is converted to a floating-point number; | ||
|
|
||
| * otherwise, both must be integers and no conversion is necessary. | ||
| implementation for built-in numeric types works as described in |
Member
There was a problem hiding this comment.
Suggested change
| implementation for built-in numeric types works as described in | |
| implementation for built-in numeric types works as described in the |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This freshens up Syntax Notes, Atoms introduction, Built-in constants, and Literals.
Identifiers and enclosed forms are left for a future PR.
References to mixed arithmetic are changed to link to the stdtypes documentation. In later passes I want to move the runtime semantics there; for now I want to make the “When a description of an arithmetic operator” note in the intro more correct.
📚 Documentation preview 📚: https://cpython-previews--144117.org.readthedocs.build/