Skip to content

Commit 2f94dd5

Browse files
Try to make docstrings for 'clip' more consistent
1 parent 31093ac commit 2f94dd5

File tree

8 files changed

+23
-19
lines changed

8 files changed

+23
-19
lines changed

pygmt/src/contour.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -83,13 +83,13 @@ def contour(self, data=None, x=None, y=None, z=None, **kwargs):
8383
I : bool
8484
Color the triangles using CPT.
8585
triangular_mesh_pen : str
86-
Pen to draw the underlying triangulation [Default is None].
86+
Pen to draw the underlying triangulation [Default is ``None``].
8787
no_clip : bool
88-
Do NOT clip contours or image at the boundaries [Default will clip
89-
to fit inside region].
88+
Do **not** clip contours or image at the frame boundaries
89+
[Default is ``False`` to fit inside ``region``].
9090
Q : float or str
9191
[*cut*][**+z**].
92-
Do not draw contours with less than cut number of points.
92+
Do not draw contours with less than *cut* number of points.
9393
skip : bool or str
9494
[**p**\|\ **t**].
9595
Skip input points outside region.

pygmt/src/grdimage.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -146,8 +146,8 @@ def grdimage(self, grid, **kwargs):
146146
Force conversion to monochrome image using the (television) YIQ
147147
transformation. Cannot be used with ``nan_transparent``.
148148
no_clip : bool
149-
Do not clip the image at the map boundary (only relevant for
150-
non-rectangular maps).
149+
Do **not** clip the image at the frame boundaries (only relevant
150+
for non-rectangular maps) [Default is ``False``].
151151
nan_transparent : bool
152152
Make grid nodes with z = NaN transparent, using the color-masking
153153
feature in PostScript Level 3 (the PS device must support PS Level

pygmt/src/inset.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -103,8 +103,8 @@ def inset(self, **kwargs):
103103
a string with the values separated by forward
104104
slashes [Default is no margins].
105105
no_clip : bool
106-
Do NOT clip features extruding outside map inset boundaries [Default
107-
is clip].
106+
Do **not** clip features extruding outside the inset frame
107+
boundaries [Default is ``False``].
108108
{region}
109109
{projection}
110110
{verbose}

pygmt/src/meca.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -231,9 +231,9 @@ def meca(
231231
determined by the z-value (i.e., event depth or the third column for
232232
an input file).
233233
no_clip : bool
234-
Do NOT skip symbols that fall outside frame boundary specified by
235-
``region`` [Default is ``False``, i.e., plot symbols inside map
236-
frame only].
234+
Do **not** skip symbols that fall outside the frame boundaries
235+
[Default is ``False``, i.e., plot symbols inside the frame
236+
boundaries only].
237237
{projection}
238238
{region}
239239
{frame}

pygmt/src/plot.py

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -168,8 +168,9 @@ def plot(self, data=None, x=None, y=None, size=None, direction=None, **kwargs):
168168
:gmt-docs:`plot.html#l`.
169169
no_clip : bool or str
170170
[**c**\|\ **r**].
171-
Do NOT clip symbols that fall outside map border [Default plots
172-
points whose coordinates are strictly inside the map border only].
171+
Do **not** clip symbols that fall outside the frame boundaries
172+
[Default plots points whose coordinates are strictly inside the
173+
frame boundaries only].
173174
The parameter does not apply to lines and polygons which are always
174175
clipped to the map region. For periodic (360-longitude) maps we
175176
must plot all symbols twice in case they are clipped by the

pygmt/src/plot3d.py

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -135,8 +135,9 @@ def plot3d(
135135
:gmt-docs:`plot3d.html#l`.
136136
no_clip : bool or str
137137
[**c**\|\ **r**].
138-
Do NOT clip symbols that fall outside map border [Default plots
139-
points whose coordinates are strictly inside the map border only].
138+
Do **not** clip symbols that fall outside the frame boundaries
139+
[Default plots points whose coordinates are strictly inside the
140+
frame boundaries only].
140141
This parameter does not apply to lines and polygons which are always
141142
clipped to the map region. For periodic (360-longitude) maps we
142143
must plot all symbols twice in case they are clipped by the

pygmt/src/text.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -146,7 +146,8 @@ def text_(
146146
Set the pen used to draw a rectangle around the text string
147147
(see ``clearance``) [Default is ``"0.25p,black,solid"``].
148148
no_clip : bool
149-
Do NOT clip text at map boundaries [Default is with clip].
149+
Do **not** clip text at the frame boundaries [Default is
150+
``False``].
150151
{verbose}
151152
{aspatial}
152153
{panel}

pygmt/src/velo.py

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -212,9 +212,10 @@ def velo(self, data=None, **kwargs):
212212
``cmap``). If instead modifier **+cf** is appended then the color from
213213
the cpt file is applied to error fill only [Default]. Use just **+c**
214214
to set both pen and fill color.
215-
no_clip: bool or str
216-
Do NOT skip symbols that fall outside the frame boundary specified
217-
by ``region`` [Default plots symbols inside frame only].
215+
no_clip: bool
216+
Do **not** skip symbols that fall outside the frame boundaries
217+
[Default is ``False``, i.e., plot symbols inside the frame
218+
boundaries only].
218219
{verbose}
219220
pen : str
220221
[*pen*][**+c**\ [**f**\|\ **l**]].

0 commit comments

Comments
 (0)