gh-132661: Document t-strings and templatelib
#135229
Draft
+452
−12
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
…nce of `templatelib.Template`.
hugovk
reviewed
Jun 13, 2025
|
@hugovk Thank you for the review and the helpful early feedback! Useful to know about linking. (FWIW this is very early stage still, so I expect plenty more linting and other issues that we'll eventually resolve.) |
11 tasks
encukou
reviewed
Jun 27, 2025
| @@ -1044,7 +1082,7 @@ readability:: | |||
|
|
|||
| Either of these parts, but not both, can be empty. For example:: | |||
|
|
|||
| 10. # (equivalent to 10.0) | |||
| 1. # (equivalent to 10.0) | |||
There was a problem hiding this comment.
This is incorrect (and unrelated).
Suggested change
| 1. # (equivalent to 10.0) | |
| 10. # (equivalent to 10.0) |
encukou
reviewed
Jun 27, 2025
| t-string | ||
| String literals prefixed with ``'t'`` or ``'T'`` are commonly called | ||
| "t-strings" which is short for | ||
| :ref:`template string literals <t-strings>`. See also :pep:`750`. |
There was a problem hiding this comment.
The PEP is the original change proposal, and it's expected to go go out of date. It's good to have a link to it in the docs (e.g. a “see also” in the main docs for the feature), so people can read the motivation and get at the discussion links, but if there's any other info in the PEP that's relevant to readers, it should go in the docs.
Suggested change
| :ref:`template string literals <t-strings>`. See also :pep:`750`. | |
| :ref:`template string literals <t-strings>`. |
(And yes, the current docs aren't too great at this.)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
[DRAFT] This has only just begun and is very much a work in progress; putting up a draft PR now for visibility.
We're keeping a TODO list of PEP 750 documentation tasks. There's lots to do.
📚 Documentation preview 📚: https://cpython-previews--135229.org.readthedocs.build/