gh-141984: Reword and reorganize the first part of Atoms docs#144117
gh-141984: Reword and reorganize the first part of Atoms docs#144117encukou merged 5 commits intopython:mainfrom
Conversation
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 |
There was a problem hiding this comment.
Why not .. impl-detail::?
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.
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...?
There was a problem hiding this comment.
I assume it's to avoid the box, which would be too distracting for a few sentences.
Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
StanFromIreland
left a comment
There was a problem hiding this comment.
Two little notes but otherwise LGTM :-)
Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
|
Thank you for the review! |
|
Thanks @encukou for the PR 🌮🎉.. I'm working now to backport this PR to: 3.14. |
…ythonGH-144117) (cherry picked from commit 112d8ac) Co-authored-by: Petr Viktorin <encukou@gmail.com> Co-authored-by: Blaise Pabon <blaise@gmail.com> Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
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/