Updates

Author: seisman

pygmt/src/basemap.py

@@ -76,7 +76,9 @@ def basemap(self, projection=None, **kwargs):
     rose : str
         Draw a map directional rose on the map.
 
-        Deprecated. Use :py:func:`pygmt.Figure.directional_rose` instead.
+        .. deprecated:: v0.17.0
+
+           Use :py:func:`pygmt.Figure.directional_rose` instead.
     compass : str
         Draw a map magnetic rose on the map at the location defined by the
         reference and anchor points.

pygmt/src/directional_rose.py

@@ -15,7 +15,11 @@ def directional_rose(  # noqa: PLR0913
     self,
     position: Sequence[str | float] | AnchorCode,
     position_type: Literal[
-        "mapcoords", "inside", "outside", "boxcoords", "plotcoords"
+        "mapcoords",
+        "boxcoords",
+        "plotcoords",
+        "inside",
+        "outside",
     ] = "mapcoords",
     width: float | str | None = None,
     justify: AnchorCode | None = None,
@@ -33,21 +37,22 @@ def directional_rose(  # noqa: PLR0913
     Parameters
     ----------
     position/position_type
-        Location of the rose. The actual meaning of this parameter depends on the
-        ``position_type`` parameter.
+        Location of the directional rose. The actual meaning of this parameter depends
+        on the ``position_type`` parameter.
 
         - ``position_type="mapcoords"``: *position* is given as (x, y) in user
           coordinates.
         - ``position_type="boxcoords"``: *position* is given as (nx, ny) in normalized
           coordinates, where (0, 0) is the lower-left corner and (1, 1) is the
-          upper-right corner of the map.
+          upper-right corner of the plot.
         - ``position_type="plotcoords"``: *position* is given as (x, y) in plot
-          coordinates.
+          coordinates, i.e., the distances in inches, centimeters, or points from the
+          lower left plot origin.
         - ``position_type="inside"``: *position* is given as a two-character
-          justification code, meaning the anchor point of the rose is inside the map
+          justification code, meaning the anchor point of the rose is inside the plot
           bounding box.
         - ``position_type="outside"``: *position* is given as a two-character
-          justification code, but the rose is outside the map bounding box.
+          justification code, but the rose is outside the plot bounding box.
     width
         Width of the rose in plot coordinates (append **i** (inch),
         **cm** (centimeters), or **p** (points)), or append % for a size in percentage
@@ -92,10 +97,10 @@ def directional_rose(  # noqa: PLR0913
                 name="position_type",
                 mapping={
                     "mapcoords": "g",
-                    "inside": "j",
-                    "outside": "J",
                     "boxcoords": "n",
                     "plotcoords": "x",
+                    "inside": "j",
+                    "outside": "J",
                 },
             ),
             Alias(position, name="position", sep="/", size=2),