Skip to content

Commit 0b59e2f

Browse files
DOC: Minor improvement of highlighting in docstrings (#3501)
1 parent 5d7a89b commit 0b59e2f

File tree

2 files changed

+6
-6
lines changed

2 files changed

+6
-6
lines changed

pygmt/figure.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -175,7 +175,7 @@ def psconvert(self, **kwargs):
175175
----------
176176
crop : str or bool
177177
Adjust the BoundingBox and HiResBoundingBox to the minimum
178-
required by the image content. Default is True. Append **+u** to
178+
required by the image content. Default is ``True``. Append **+u** to
179179
first remove any GMT-produced time-stamps. Append **+r** to
180180
*round* the HighResBoundingBox instead of using the ``ceil``
181181
function. This is going against Adobe Law but can be useful when
@@ -219,8 +219,8 @@ def psconvert(self, **kwargs):
219219
towards black (100%) [no fading, 0]. Append **+g**\ *paint* to
220220
paint the BoundingBox behind the illustration and append **+p**\
221221
[*pen*] to draw the BoundingBox outline (append a pen or accept
222-
the default pen of 0.25p,black). **Note**: If both **+g** and
223-
**+f** are used then we use paint as the fade color instead of
222+
the default pen of ``"0.25p,black,solid"``). **Note**: If both **+g** and
223+
**+f** are used then we use *paint* as the fade color instead of
224224
black. Append **+i** to enforce gray-shades by using ICC profiles.
225225
anti_aliasing : str
226226
[**g**\|\ **p**\|\ **t**\][**1**\|\ **2**\|\ **4**].
@@ -242,8 +242,8 @@ def psconvert(self, **kwargs):
242242
{verbose}
243243
"""
244244
kwargs = self._preprocess(**kwargs)
245-
# pytest-mpl v0.17.0 added the "metadata" parameter to `Figure.savefig`, which
246-
# is not recognized. So remove it before calling `Figure.psconvert`.
245+
# pytest-mpl v0.17.0 added the "metadata" parameter to Figure.savefig, which
246+
# is not recognized. So remove it before calling Figure.psconvert.
247247
kwargs.pop("metadata", None)
248248
# Default cropping the figure to True
249249
if kwargs.get("A") is None:

pygmt/src/surface.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ def surface(
4747
oscillations and false local maxima or minima (see Smith and Wessel,
4848
1990), and you may wish to use :math:`t > 0` to suppress these effects.
4949
Experience suggests :math:`t \sim 0.25` usually looks good for potential
50-
field data and t should be larger (:math:`t \sim 0.35`) for steep
50+
field data and :math:`t` should be larger (:math:`t \sim 0.35`) for steep
5151
topography data. :math:`t = 1` gives a harmonic surface (no maxima or
5252
minima are possible except at control data points). It is recommended that
5353
the user preprocess the data with :func:`pygmt.blockmean`,

0 commit comments

Comments
 (0)