fmt_docstrings: Use string template syntax for docstring placeholders and support curly braces in docstrings #4210
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
seisman
force-pushed
the
docstring/placeholder
branch
4 times, most recently
from
c50845b to
f44e356
Compare
seisman
changed the title
seisman
force-pushed
the
docstring/placeholder
branch
from
03ac916 to
7c1b978
Compare
seisman
force-pushed
the
docstring/placeholder
branch
2 times, most recently
from
565d256 to
f9e1a80
Compare
seisman
force-pushed
the
docstring/placeholder
branch
from
f9e1a80 to
99dd6e8
Compare
seisman
changed the title
seisman
changed the title
yvonnefroehlich
approved these changes
Nov 15, 2025
seisman
added
final review call
Member
Author
|
This is a big change in how the docstrings are written. Hopefully, @weiji14 can give this PR a review. |
weiji14
approved these changes
Nov 26, 2025
Member
weiji14
left a comment
weiji14
left a comment
There was a problem hiding this comment.
For a second I thought this was using Python 3.14 t-strings, but it is unrelated. LGTM!
seisman
removed
the
final review call
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.
Description of proposed changes
See #3815 for the original issue report and the solution.
This PR uses the
string.Templatemethod to avoid using curly braces for docstring placeholders.Changes in this PR include:
{projection}to$projectiontable-classestotable_classesbecausestring.Templatedoesn't work well with-{{/}}with{/}in LaTeX math equationsFixes #3815.
Preview:
Wrappers with math equations:
An example page with updated docstring placeholder syntax: