Figure.plot/Figure.plot3d: Refactor the straight_line parameter to the new alias system (#4067)

Author: seisman

pygmt/src/plot.py

@@ -5,7 +5,7 @@
 from typing import Literal
 
 from pygmt._typing import PathLike, TableLike
-from pygmt.alias import AliasSystem
+from pygmt.alias import Alias, AliasSystem
 from pygmt.clib import Session
 from pygmt.exceptions import GMTInvalidInput, GMTTypeError
 from pygmt.helpers import (
@@ -21,7 +21,6 @@
 
 @fmt_docstring
 @use_alias(
-    A="straight_line",
     B="frame",
     C="cmap",
     D="offset",
@@ -57,7 +56,7 @@ def plot(  # noqa: PLR0912, PLR0913
     size=None,
     symbol=None,
     direction=None,
-    straight_line: bool | Literal["x", "y"] = False,  # noqa: ARG001
+    straight_line: bool | Literal["x", "y"] = False,
     projection=None,
     verbose: Literal["quiet", "error", "warning", "timing", "info", "compat", "debug"]
     | bool = False,
@@ -88,6 +87,7 @@ def plot(  # noqa: PLR0912, PLR0913
     Full GMT docs at :gmt-docs:`plot.html`.
 
     {aliases}
+       - A = straight_line
        - J = projection
        - V = verbose
        - c = panel
@@ -286,7 +286,9 @@ def plot(  # noqa: PLR0912, PLR0913
     if kwargs.get("S") is None and _data_geometry_is_point(data, kind):
         kwargs["S"] = "s0.2c"
 
-    aliasdict = AliasSystem().add_common(
+    aliasdict = AliasSystem(
+        A=Alias(straight_line, name="straight_line"),
+    ).add_common(
         J=projection,
         V=verbose,
         c=panel,

pygmt/src/plot3d.py

@@ -5,7 +5,7 @@
 from typing import Literal
 
 from pygmt._typing import PathLike, TableLike
-from pygmt.alias import AliasSystem
+from pygmt.alias import Alias, AliasSystem
 from pygmt.clib import Session
 from pygmt.exceptions import GMTInvalidInput, GMTTypeError
 from pygmt.helpers import (
@@ -21,7 +21,6 @@
 
 @fmt_docstring
 @use_alias(
-    A="straight_line",
     B="frame",
     C="cmap",
     D="offset",
@@ -59,7 +58,7 @@ def plot3d(  # noqa: PLR0912, PLR0913
     size=None,
     symbol=None,
     direction=None,
-    straight_line: bool | Literal["x", "y"] = False,  # noqa: ARG001
+    straight_line: bool | Literal["x", "y"] = False,
     projection=None,
     verbose: Literal["quiet", "error", "warning", "timing", "info", "compat", "debug"]
     | bool = False,
@@ -90,6 +89,7 @@ def plot3d(  # noqa: PLR0912, PLR0913
     Full GMT docs at :gmt-docs:`plot3d.html`.
 
     {aliases}
+       - A = straight_line
        - J = projection
        - V = verbose
        - c = panel
@@ -265,7 +265,9 @@ def plot3d(  # noqa: PLR0912, PLR0913
     if kwargs.get("S") is None and _data_geometry_is_point(data, kind):
         kwargs["S"] = "u0.2c"
 
-    aliasdict = AliasSystem().add_common(
+    aliasdict = AliasSystem(
+        A=Alias(straight_line, name="straight_line"),
+    ).add_common(
         J=projection,
         V=verbose,
         c=panel,