Minor kwarg name change for delta_text_kwargs

Author: JAnns98

dabest/_effsize_objects.py

@@ -1213,7 +1213,7 @@ def plot(
             Pass relevant keyword arguments to the delta text. Pass any keyword arguments accepted by
             matplotlib.text.Text here, as a string. If None, the following keywords are passed:
             {"color": None, "alpha": 1, "fontsize": 10, "ha": 'center', "va": 'center', "rotation": 0, 
-            "x_location": 'right', "x_coordinates": None, "y_coordinates": None, "x_adjust": 0}
+            "x_location": 'right', "x_coordinates": None, "y_coordinates": None, "offset": 0}
             Use "x_coordinates" and "y_coordinates" if you would like to specify the text locations manually. 
             Use "x_adjust" to adjust the x location of all the texts (positive moves right, negative left).
         delta_dot : boolean, default True

dabest/misc_tools.py

@@ -347,7 +347,7 @@ def get_kwargs(
                 "x_location": 'right', 
                 "x_coordinates": None, 
                 "y_coordinates": None,
-                "x_adjust": 0
+                "offset": 0
     }
     if plot_kwargs["delta_text_kwargs"] is None:
         delta_text_kwargs = default_delta_text_kwargs

dabest/plot_tools.py

@@ -1224,8 +1224,8 @@ def delta_text_plotter(
     if show_mini_meta: Delta_Values.append(mini_meta_delta.difference)
 
     # Collect the X-coordinates for the delta text
-    delta_text_x_coordinates = delta_text_kwargs.get('x_coordinates')
-    delta_text_x_adjustment = delta_text_kwargs.get('x_adjust')
+    delta_text_x_coordinates = delta_text_kwargs.pop('x_coordinates')
+    delta_text_x_adjustment = delta_text_kwargs.pop('offset')
 
     if delta_text_x_coordinates is not None:
         if not isinstance(delta_text_x_coordinates, (list, tuple)) or not all(isinstance(x, (int, float)) for x in delta_text_x_coordinates):
@@ -1240,8 +1240,6 @@ def delta_text_plotter(
         if show_mini_meta: delta_text_x_coordinates.append(max(swarm_plot_ax.get_xticks())+2+X_Adjust)
         if show_delta2: delta_text_x_coordinates.append(max(swarm_plot_ax.get_xticks())+2-0.35)
         if show_mini_meta or show_delta2: ticks_to_plot.append(max(ticks_to_plot)+1)
-    delta_text_kwargs.pop('x_coordinates')
-    delta_text_kwargs.pop('x_adjust')
 
     # Collect the Y-coordinates for the delta text
     delta_text_y_coordinates = delta_text_kwargs.get('y_coordinates')

nbs/API/effsize_objects.ipynb

@@ -1372,7 +1372,7 @@
     "            Pass relevant keyword arguments to the delta text. Pass any keyword arguments accepted by\n",
     "            matplotlib.text.Text here, as a string. If None, the following keywords are passed:\n",
     "            {\"color\": None, \"alpha\": 1, \"fontsize\": 10, \"ha\": 'center', \"va\": 'center', \"rotation\": 0, \n",
-    "            \"x_location\": 'right', \"x_coordinates\": None, \"y_coordinates\": None, \"x_adjust\": 0}\n",
+    "            \"x_location\": 'right', \"x_coordinates\": None, \"y_coordinates\": None, \"offset\": 0}\n",
     "            Use \"x_coordinates\" and \"y_coordinates\" if you would like to specify the text locations manually. \n",
     "            Use \"x_adjust\" to adjust the x location of all the texts (positive moves right, negative left).\n",
     "        delta_dot : boolean, default True\n",

nbs/API/misc_tools.ipynb

@@ -400,7 +400,7 @@
     "                \"x_location\": 'right', \n",
     "                \"x_coordinates\": None, \n",
     "                \"y_coordinates\": None,\n",
-    "                \"x_adjust\": 0\n",
+    "                \"offset\": 0\n",
     "    }\n",
     "    if plot_kwargs[\"delta_text_kwargs\"] is None:\n",
     "        delta_text_kwargs = default_delta_text_kwargs\n",

nbs/API/plot_tools.ipynb

@@ -1274,8 +1274,8 @@
     "    if show_mini_meta: Delta_Values.append(mini_meta_delta.difference)\n",
     "\n",
     "    # Collect the X-coordinates for the delta text\n",
-    "    delta_text_x_coordinates = delta_text_kwargs.get('x_coordinates')\n",
-    "    delta_text_x_adjustment = delta_text_kwargs.get('x_adjust')\n",
+    "    delta_text_x_coordinates = delta_text_kwargs.pop('x_coordinates')\n",
+    "    delta_text_x_adjustment = delta_text_kwargs.pop('offset')\n",
     "\n",
     "    if delta_text_x_coordinates is not None:\n",
     "        if not isinstance(delta_text_x_coordinates, (list, tuple)) or not all(isinstance(x, (int, float)) for x in delta_text_x_coordinates):\n",
@@ -1290,8 +1290,6 @@
     "        if show_mini_meta: delta_text_x_coordinates.append(max(swarm_plot_ax.get_xticks())+2+X_Adjust)\n",
     "        if show_delta2: delta_text_x_coordinates.append(max(swarm_plot_ax.get_xticks())+2-0.35)\n",
     "        if show_mini_meta or show_delta2: ticks_to_plot.append(max(ticks_to_plot)+1)\n",
-    "    delta_text_kwargs.pop('x_coordinates')\n",
-    "    delta_text_kwargs.pop('x_adjust')\n",
     "\n",
     "    # Collect the Y-coordinates for the delta text\n",
     "    delta_text_y_coordinates = delta_text_kwargs.get('y_coordinates')\n",

nbs/tests/mpl_image_tests/test_plot_aesthetics.py

@@ -278,7 +278,7 @@ def test_227_multi_2group_meandiff_deltatext_kwargs_specificy_coordinates():
 
 @pytest.mark.mpl_image_compare(tolerance=8)
 def test_228_multi_2group_meandiff_deltatext_kwargs_x_adjust():
-    return multi_2group.mean_diff.plot(delta_text=True, delta_text_kwargs={"x_adjust":0.1});
+    return multi_2group.mean_diff.plot(delta_text=True, delta_text_kwargs={"offset":0.1});
 
 # Jitter
 @pytest.mark.mpl_image_compare(tolerance=8)