Figure.meca: Deprecate parameter labelbox to label_box (Will be removed in v0.20.0) (#4274)

Author: yvonnefroehlich

examples/tutorials/advanced/focal_mechanisms.py

@@ -284,13 +284,13 @@
 # parameter. Additionally, the location of the label relative to the beachball [Default
 # is ``"TC"``, i.e., Top Center] can be changed by appending **+j** and an offset can
 # be applied by appending **+o** with values for *dx*\ /*dy*. Add a colored [Default is
-# white] box behind the label via the label ``labelbox``. Force a fixed size of the
+# white] box behind the label via the parameter ``label_box``. Force a fixed size of the
 # beachball by appending **+m** to the argument passed to the ``scale`` parameter.
 
 fig = pygmt.Figure()
 fig.coast(region="d", projection="N10c", land="lightgray", frame=True)
 
-fig.meca(spec=aki_multiple, scale="0.4c+m+f5p", labelbox="white@30", offset="+s0.1c")
+fig.meca(spec=aki_multiple, scale="0.4c+m+f5p", label_box="white@30", offset="+s0.1c")
 
 fig.show()
 
@@ -315,7 +315,7 @@
     spec=aki_multiple,
     scale="0.4c+f5p",
     offset="0.2p,gray30+s0.1c",
-    labelbox="white@30",
+    label_box="white@30",
     cmap=True,
     outline="0.2p,gray30",
 )

pygmt/src/meca.py

@@ -116,6 +116,7 @@ def _auto_offset(spec) -> bool:
 
 
 @fmt_docstring
+@deprecate_parameter("labelbox", "label_box", "v0.18.0", remove_version="v0.20.0")
 @deprecate_parameter(
     "extensionfill", "extension_fill", "v0.18.0", remove_version="v0.20.0"
 )
@@ -126,7 +127,7 @@ def _auto_offset(spec) -> bool:
     A="offset",
     C="cmap",
     E="extension_fill",
-    Fr="labelbox",
+    Fr="label_box",
     G="compression_fill",
     L="outline",
     T="nodal",
@@ -297,7 +298,7 @@ def meca(  # noqa: PLR0913
         length must match the number of events. This parameter is only used if ``spec``
         is a dictionary or a :class:`pandas.DataFrame`, and it overrides any existing
         ``event_name`` labels in ``spec``.
-    labelbox : bool or str
+    label_box : bool or str
         [*fill*].
         Draw a box behind the label if given via ``event_name``. Use *fill* to give a
         fill color [Default is ``"white"``].