Skip to content

Commit e4e1759

Browse files
committed
updates
1 parent 8696c72 commit e4e1759

File tree

1 file changed

+15
-22
lines changed

1 file changed

+15
-22
lines changed

pygmt/src/directional_rose.py

Lines changed: 15 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -20,16 +20,12 @@ def directional_rose( # noqa: PLR0913
2020
"plotcoords",
2121
"inside",
2222
"outside",
23-
] = "mapcoords",
23+
] = "plotcoords",
2424
width: float | str | None = None,
2525
justify: AnchorCode | None = None,
2626
anchor_offset: Sequence[float | str] | None = None,
2727
label: Sequence[str] | bool = False,
2828
fancy: Literal[1, 2, 3] | bool = False,
29-
box=None,
30-
perspective=None,
31-
verbose=None,
32-
transparency=None,
3329
):
3430
r"""
3531
Add a directional rose to the map.
@@ -40,19 +36,16 @@ def directional_rose( # noqa: PLR0913
4036
Location of the directional rose. The actual meaning of this parameter depends
4137
on the ``position_type`` parameter.
4238
43-
- ``position_type="mapcoords"``: *position* is given as (x, y) in user
44-
coordinates.
45-
- ``position_type="boxcoords"``: *position* is given as (nx, ny) in normalized
46-
coordinates, where (0, 0) is the lower-left corner and (1, 1) is the
47-
upper-right corner of the plot.
48-
- ``position_type="plotcoords"``: *position* is given as (x, y) in plot
49-
coordinates, i.e., the distances in inches, centimeters, or points from the
50-
lower left plot origin.
51-
- ``position_type="inside"``: *position* is given as a two-character
52-
justification code, meaning the anchor point of the rose is inside the plot
53-
bounding box.
54-
- ``position_type="outside"``: *position* is given as a two-character
55-
justification code, but the rose is outside the plot bounding box.
39+
- ``"mapcoords"``: *position* is given as (x, y) in user coordinates.
40+
- ``"boxcoords"``: *position* is given as (nx, ny) in normalized coordinates,
41+
where (0, 0) is the lower-left corner and (1, 1) is the upper-right corner of
42+
the plot.
43+
- ``"plotcoords"``: *position* is given as (x, y) in plot coordinates, i.e., the
44+
distances in inches, centimeters, or points from the lower left plot origin.
45+
- ``"inside"``: *position* is given as a two-character justification code,
46+
meaning the anchor point of the rose is inside the plot bounding box.
47+
- ``"outside"``: *position* is given as a two-character justification code, but
48+
the rose is outside the plot bounding box.
5649
width
5750
Width of the rose in plot coordinates (append **i** (inch),
5851
**cm** (centimeters), or **p** (points)), or append % for a size in percentage
@@ -79,6 +72,10 @@ def directional_rose( # noqa: PLR0913
7972
from vertical **T**\(op), **M**\(iddle), or **B**\(ottom) and horizontal
8073
**L**\(eft), **C**\(entre), or **R**\(ight).
8174
75+
{perspective}
76+
{verbose}
77+
{transparency}
78+
8279
Examples
8380
--------
8481
>>> import pygmt
@@ -90,7 +87,6 @@ def directional_rose( # noqa: PLR0913
9087
self._activate_figure()
9188

9289
aliasdict = AliasSystem(
93-
F=Alias(box, name="box"),
9490
Td=[
9591
Alias(
9692
position_type,
@@ -110,9 +106,6 @@ def directional_rose( # noqa: PLR0913
110106
Alias(label, name="label", prefix="+l", sep=",", size=4),
111107
Alias(anchor_offset, name="anchor_offset", prefix="+o", sep="/", size=2),
112108
],
113-
V=Alias(verbose, name="verbose"),
114-
p=Alias(perspective, name="perspective"),
115-
t=Alias(transparency, name="transparency"),
116109
)
117110

118111
with Session() as lib:

0 commit comments

Comments
 (0)