Skip to content

Commit 6d5264f

Browse files
committed
Rename facadepen to facade_pen
1 parent ce346a5 commit 6d5264f

2 files changed

Lines changed: 9 additions & 9 deletions

File tree

pygmt/src/grdview.py

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ def grdview( # noqa: PLR0913
3030
grid: PathLike | xr.DataArray,
3131
plane: float | bool = False,
3232
facade_fill: str | None = None,
33-
facadepen: str | None = None,
33+
facade_pen: str | None = None,
3434
projection: str | None = None,
3535
zscale: float | str | None = None,
3636
zsize: float | str | None = None,
@@ -62,7 +62,7 @@ def grdview( # noqa: PLR0913
6262
- N = plane, facade_fill
6363
- R = region
6464
- V = verbose
65-
- Wf = facadepen
65+
- Wf = facade_pen
6666
- c = panel
6767
- p = perspective
6868
- t = transparency
@@ -90,12 +90,12 @@ def grdview( # noqa: PLR0913
9090
plane
9191
Draw a plane at the specified z-level. If ``True``, default to the minimum value
9292
in the grid. However, if ``region`` was used to set zmin/zmax then that value is
93-
used if it is less than the grid minimum value. Use ``facadepen`` and
93+
used if it is less than the grid minimum value. Use ``facade_pen`` and
9494
``facade_fill`` to control the appearance of the plane.
9595
facade_fill
9696
Fill for the frontal facade between the plane specified by ``plane`` and the
9797
data perimeter.
98-
facadepen
98+
faacde_pen
9999
Set the pen attributes used for the facade.
100100
surftype : str
101101
Specify cover type of the grid. Select one of following settings:
@@ -164,8 +164,8 @@ def grdview( # noqa: PLR0913
164164
"""
165165
self._activate_figure()
166166

167-
# Enable 'plane' if 'facade_fill' or 'facadepen' is set
168-
if plane is False and (facade_fill is not None or facadepen is not None):
167+
# Enable 'plane' if 'facade_fill' or 'facade_pen' is set
168+
if plane is False and (facade_fill is not None or facade_pen is not None):
169169
plane = True
170170

171171
aliasdict = AliasSystem(
@@ -175,7 +175,7 @@ def grdview( # noqa: PLR0913
175175
Alias(plane, name="plane"),
176176
Alias(facade_fill, name="facade_fill", prefix="+g"),
177177
],
178-
Wf=Alias(facadepen, name="facadepen"),
178+
Wf=Alias(facade_pen, name="facade_pen"),
179179
).add_common(
180180
B=frame,
181181
J=projection,

pygmt/tests/test_grdview.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -208,7 +208,7 @@ def test_grdview_on_a_plane_styled_with_facadepen(xrgrid):
208208
plane=100,
209209
perspective=[225, 30],
210210
zscale=0.005,
211-
facadepen="0.5p,blue,dash",
211+
facade_pen="0.5p,blue,dash",
212212
)
213213
return fig
214214

@@ -221,7 +221,7 @@ def test_grdview_facadepen_default_plane(xrgrid):
221221
"""
222222
fig = Figure()
223223
fig.grdview(
224-
grid=xrgrid, perspective=[225, 30], zscale=0.005, facadepen="0.5p,blue,dash"
224+
grid=xrgrid, perspective=[225, 30], zscale=0.005, facade_pen="0.5p,blue,dash"
225225
)
226226
return fig
227227

0 commit comments

Comments
 (0)