TYP: Add type hints for the 'projection' parameter (#4123)

Author: seisman

pygmt/helpers/decorators.py

@@ -269,7 +269,7 @@
             the viewpoint [Default is ``[180, 90]``]. Full documentation is at
             :gmt-docs:`gmt.html#perspective-full`.""",
     "projection": r"""
-        projection : str
+        projection
             *projcode*\[*projparams*/]\ *width*\|\ *scale*.
             Select map :doc:`projection </projections/index>`.""",
     "region": r"""
@@ -415,7 +415,7 @@ def fmt_docstring(module_func):
     region : str or list
         *xmin/xmax/ymin/ymax*\ [**+r**][**+u**\ *unit*].
         Specify the :doc:`region </tutorials/basics/regions>` of interest.
-    projection : str
+    projection
         *projcode*\[*projparams*/]\ *width*\|\ *scale*.
         Select map :doc:`projection </projections/index>`.
     <BLANKLINE>

pygmt/src/basemap.py

@@ -25,7 +25,7 @@
 @kwargs_to_strings(R="sequence", p="sequence")
 def basemap(
     self,
-    projection=None,
+    projection: str | None = None,
     verbose: Literal["quiet", "error", "warning", "timing", "info", "compat", "debug"]
     | bool = False,
     panel: int | tuple[int, int] | bool = False,

pygmt/src/coast.py

@@ -37,7 +37,7 @@
 @kwargs_to_strings(R="sequence", p="sequence")
 def coast(
     self,
-    projection=None,
+    projection: str | None = None,
     resolution: Literal[
         "auto", "full", "high", "intermediate", "low", "crude", None
     ] = None,

pygmt/src/colorbar.py

@@ -29,7 +29,7 @@
 @kwargs_to_strings(R="sequence", G="sequence", I="sequence", p="sequence")
 def colorbar(
     self,
-    projection=None,
+    projection: str | None = None,
     box: Box | bool = False,
     verbose: Literal["quiet", "error", "warning", "timing", "info", "compat", "debug"]
     | bool = False,

pygmt/src/contour.py

@@ -43,7 +43,7 @@ def contour(
     y=None,
     z=None,
     no_clip: bool = False,
-    projection=None,
+    projection: str | None = None,
     verbose: Literal["quiet", "error", "warning", "timing", "info", "compat", "debug"]
     | bool = False,
     panel: int | tuple[int, int] | bool = False,

pygmt/src/grdcontour.py

@@ -40,7 +40,7 @@
 def grdcontour(
     self,
     grid: PathLike | xr.DataArray,
-    projection=None,
+    projection: str | None = None,
     verbose: Literal["quiet", "error", "warning", "timing", "info", "compat", "debug"]
     | bool = False,
     panel: int | tuple[int, int] | bool = False,

pygmt/src/grdcut.py

@@ -33,7 +33,7 @@ def grdcut(
     grid: PathLike | xr.DataArray,
     kind: Literal["grid", "image"] = "grid",
     outgrid: PathLike | None = None,
-    projection=None,
+    projection: str | None = None,
     verbose: Literal["quiet", "error", "warning", "timing", "info", "compat", "debug"]
     | bool = False,
     **kwargs,

pygmt/src/grdimage.py

@@ -33,7 +33,7 @@ def grdimage(
     grid: PathLike | xr.DataArray,
     monochrome: bool = False,
     no_clip: bool = False,
-    projection=None,
+    projection: str | None = None,
     verbose: Literal["quiet", "error", "warning", "timing", "info", "compat", "debug"]
     | bool = False,
     panel: int | tuple[int, int] | bool = False,

pygmt/src/grdproject.py

@@ -30,7 +30,7 @@
 def grdproject(
     grid: PathLike | xr.DataArray,
     outgrid: PathLike | None = None,
-    projection=None,
+    projection: str | None = None,
     verbose: Literal["quiet", "error", "warning", "timing", "info", "compat", "debug"]
     | bool = False,
     **kwargs,

pygmt/src/grdview.py

@@ -35,7 +35,7 @@
 def grdview(
     self,
     grid: PathLike | xr.DataArray,
-    projection=None,
+    projection: str | None = None,
     verbose: Literal["quiet", "error", "warning", "timing", "info", "compat", "debug"]
     | bool = False,
     panel: int | tuple[int, int] | bool = False,