Figure.legend: Add aliases for -S (scale) and -B (frame) (#4254)

Author: seisman

pygmt/src/legend.py

@@ -22,13 +22,15 @@
 
 @fmt_docstring
 @use_alias(D="position")
-def legend(
+def legend(  # noqa: PLR0913
     self,
     spec: PathLike | io.StringIO | None = None,
-    projection: str | None = None,
-    region: Sequence[float | str] | str | None = None,
+    scale: float | None = None,
     position="JTR+jTR+o0.2c",
     box: Box | bool = False,
+    projection: str | None = None,
+    region: Sequence[float | str] | str | None = None,
+    frame: str | Sequence[str] | bool = False,
     verbose: Literal["quiet", "error", "warning", "timing", "info", "compat", "debug"]
     | bool = False,
     panel: int | Sequence[int] | bool = False,
@@ -48,9 +50,11 @@ def legend(
     Full GMT docs at :gmt-docs:`legend.html`.
 
     $aliases
+       - B = frame
        - F = box
        - J = projection
        - R = region
+       - S = scale
        - V = verbose
        - c = panel
        - p = perspective
@@ -67,8 +71,6 @@ def legend(
         - A :class:`io.StringIO` object containing the legend specification
 
         See :gmt-docs:`legend.html` for the definition of the legend specification.
-    $projection
-    $region
     position : str
         [**g**\|\ **j**\|\ **J**\|\ **n**\|\ **x**]\ *refpoint*\
         **+w**\ *width*\ [/*height*]\ [**+j**\ *justify*]\ [**+l**\ *spacing*]\
@@ -82,6 +84,11 @@ def legend(
         rectangular box is drawn using :gmt-term:`MAP_FRAME_PEN`. To customize the box
         appearance, pass a :class:`pygmt.params.Box` object to control style, fill, pen,
         and other box properties.
+    scale
+        Scale all symbol sizes by a common scale [Default is 1.0, i.e., no scaling].
+    $projection
+    $region
+    $frame
     $verbose
     $panel
     $perspective
@@ -105,7 +112,9 @@ def legend(
 
     aliasdict = AliasSystem(
         F=Alias(box, name="box"),
+        S=Alias(scale, name="scale"),
     ).add_common(
+        B=frame,
         J=projection,
         R=region,
         V=verbose,