Skip to content

fmt_docstrings: Use string template syntax for docstring placeholders and support curly braces in docstrings #4210

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.

Sign up for GitHub

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

Merged
seisman merged 10 commits into from
Nov 26, 2025
Merged

fmt_docstrings: Use string template syntax for docstring placeholders and support curly braces in docstrings #4210

Changes from 1 commit
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
bb24135
fmt_docstrings: Use string.Template for docstring placeholders
seisman Nov 15, 2025
92d14a7
Update docstring placeholders to the string.Template syntax
seisman Nov 15, 2025
b428491
Update {aliases} to $aliases and {table-classes} to $table_classes
seisman Nov 15, 2025
99dd6e8
Replace {{/}} with {/} in LaTeX math equations
seisman Nov 15, 2025
c6b9661
grdgradient was incorrectly updated
seisman Nov 15, 2025
1d80d2a
Merge branch 'main' into docstring/placeholder
seisman Nov 16, 2025
28878a8
Merge branch 'main' into docstring/placeholder
seisman Nov 18, 2025
0ab92d1
Merge branch 'main' into docstring/placeholder
seisman Nov 20, 2025
2951f30
Merge branch 'main' into docstring/placeholder
seisman Nov 24, 2025
dca53fd
Merge branch 'main' into docstring/placeholder
seisman Nov 26, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
fmt_docstrings: Use string.Template for docstring placeholders
  • Loading branch information
@seisman
seisman committed Nov 15, 2025
commit bb241359138bdb830c888941cb0015c5f67043a3
4 changes: 2 additions & 2 deletions pygmt/helpers/decorators.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
"""

import functools
import string
import textwrap
import warnings
from inspect import Parameter, signature
Expand Down Expand Up @@ -467,8 +468,7 @@ def fmt_docstring(module_func):
# Dedent the docstring to make it all match the option text.
docstring = textwrap.dedent(module_func.__doc__)

module_func.__doc__ = docstring.format(**filler_text)

module_func.__doc__ = string.Template(docstring).safe_substitute(**filler_text)
return module_func


Expand Down