Skip to content

Commit 03ac916

Browse files
committed
Replace table-classes with table_classes
1 parent 4513ae2 commit 03ac916

File tree

2 files changed

+7
-7
lines changed

2 files changed

+7
-7
lines changed

pygmt/helpers/decorators.py

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -396,7 +396,7 @@ def fmt_docstring(module_func):
396396
397397
Examples
398398
--------
399-
399+
>>> from pygmt.helpers import fmt_docstring
400400
>>> @fmt_docstring
401401
... @use_alias(R="region", J="projection")
402402
... def gmtinfo(**kwargs):
@@ -407,11 +407,11 @@ def fmt_docstring(module_func):
407407
... ----------
408408
... data
409409
... Pass in either a file name to an ASCII data table, a 2-D
410-
... {table-classes}.
411-
... {region}
412-
... {projection}
410+
... ${table_classes}.
411+
... ${region}
412+
... ${projection}
413413
...
414-
... {aliases}
414+
... ${aliases}
415415
... '''
416416
... pass
417417
>>> print(gmtinfo.__doc__)
@@ -452,7 +452,7 @@ def fmt_docstring(module_func):
452452
aliases.append(f" - {arg} = {alias}")
453453
filler_text["aliases"] = "\n".join(aliases)
454454

455-
filler_text["table-classes"] = (
455+
filler_text["table_classes"] = (
456456
":class:`numpy.ndarray`, a :class:`pandas.DataFrame`, an\n"
457457
" :class:`xarray.Dataset` made up of 1-D :class:`xarray.DataArray`\n"
458458
" data variables, or a :class:`geopandas.GeoDataFrame` containing the\n"

pygmt/src/select.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ def select(
8787
----------
8888
data
8989
Pass in either a file name to an ASCII data table, a 2-D
90-
${table-classes}.
90+
${table_classes}.
9191
${output_type}
9292
${outfile}
9393
${area_thresh}

0 commit comments

Comments
 (0)