Figure.velo: Deprecate parameters uncertaintyfill to uncertainty_fill (Will be removed in v0.20.0) (#4272)

Author: yvonnefroehlich

examples/gallery/seismology/velo_arrow_ellipse.py

@@ -33,7 +33,7 @@
     projection="x0.8c",
     frame=["WSne", "2g2f"],
     spec="e0.2/0.39+f18",
-    uncertaintyfill="lightblue1",
+    uncertainty_fill="lightblue1",
     pen="0.6p,red",
     line=True,
     vector="0.3c+p1p+e+gred",

examples/gallery/symbols/patterns.py

@@ -16,7 +16,7 @@
 - :meth:`pygmt.Figure.solar`: Day-light terminators via ``fill``
 - :meth:`pygmt.Figure.ternary`: Symbols via ``fill``
 - :meth:`pygmt.Figure.velo`: Uncertainty wedges and velocity error ellipses via
-  ``uncertaintyfill``
+  ``uncertainty_fill``
 - :meth:`pygmt.Figure.wiggle`: Anomalies via ``positive_fill`` and ``negative_fill``
 
 GMT provides 90 predefined 1-bit patterns, which are numbered from 1 to 90. In addition,

pygmt/src/velo.py

@@ -11,15 +11,18 @@
 from pygmt.alias import Alias, AliasSystem
 from pygmt.clib import Session
 from pygmt.exceptions import GMTInvalidInput, GMTTypeError
-from pygmt.helpers import build_arg_list, fmt_docstring, use_alias
+from pygmt.helpers import build_arg_list, deprecate_parameter, fmt_docstring, use_alias
 
 
 @fmt_docstring
+@deprecate_parameter(
+    "uncertaintyfill", "uncertainty_fill", "v0.18.0", remove_version="v0.20.0"
+)
 @use_alias(
     A="vector",
     C="cmap",
     D="rescale",
-    E="uncertaintyfill",
+    E="uncertainty_fill",
     G="fill",
     H="scale",
     I="shading",
@@ -97,7 +100,7 @@ def velo(  # noqa : PLR0913
           labeling. The arrow will be drawn with the pen attributes specified
           by the ``pen`` parameter and the arrow-head can be colored via
           ``fill``. The ellipse will be filled with the color or pattern
-          specified by the ``uncertaintyfill`` parameter [Default is
+          specified by the ``uncertainty_fill`` parameter [Default is
           transparent], and its outline will be drawn if ``line`` is selected
           using the pen selected (by ``pen`` if not given by ``line``).
           Parameters are expected to be in the following columns:
@@ -130,7 +133,7 @@ def velo(  # noqa : PLR0913
           labeling. The arrow will be drawn with the pen attributes specified
           by the ``pen`` parameter and the arrow-head can be colored via
           ``fill``. The ellipse will be filled with the color or pattern
-          specified by the ``uncertaintyfill`` parameter [Default is
+          specified by the ``uncertainty_fill`` parameter [Default is
           transparent], and its outline will be drawn if ``line`` is selected
           using the pen selected (by ``pen`` if not given by ``line``).
           Parameters are expected to be in the following columns:
@@ -149,7 +152,7 @@ def velo(  # noqa : PLR0913
           extra column. Rotation values are multiplied by *wedgemag* before
           plotting. For example, setting *wedgemag* to 1.e7 works well for
           rotations of the order of 100 nanoradians/yr. Use ``fill`` to set
-          the fill color or pattern for the wedge, and ``uncertaintyfill`` to
+          the fill color or pattern for the wedge, and ``uncertainty_fill`` to
           set the color or pattern for the uncertainty. Parameters are
           expected to be in the following columns:
 
@@ -183,10 +186,10 @@ def velo(  # noqa : PLR0913
         Can be used to rescale the uncertainties of velocities (``spec="e"``
         and ``spec="r"``) and rotations (``spec="w"``). Can be combined with
         the ``confidence`` variable.
-    uncertaintyfill : str
+    uncertainty_fill : str
         Set color or pattern for filling uncertainty wedges (``spec="w"``)
         or velocity error ellipses (``spec="e"`` or ``spec="r"``).
-        If ``uncertaintyfill`` is not specified, the uncertainty regions
+        If ``uncertainty_fill`` is not specified, the uncertainty regions
         will be transparent. **Note**: Using ``cmap`` and ``zvalue="+e"``
         will update the uncertainty fill color based on the selected measure
         in ``zvalue`` [Default is magnitude error]. More details at

pygmt/tests/test_velo.py

@@ -79,7 +79,7 @@ def test_velo_pandas_dataframe(dataframe):
         region=[-10, 8, -10, 6],
         projection="x0.8c",
         pen="0.6p,red",
-        uncertaintyfill="lightblue1",
+        uncertainty_fill="lightblue1",
         line=True,
     )
     return fig