Deprecate hover_formatters (#1637)

Author: maximlt

doc/ref/deprecations.md

@@ -4,6 +4,7 @@ List of currently deprecated APIs:
 
 | Warning | Description |
 |-|-|
+| `DeprecationWarning` since `0.12.0` | `hover_formatters` argument, use `hover_tooltips` instead. |
 | `FutureWarning` since `0.12.0` | Passing DuckDB objects to `hvplot.plotting.plot`, use `import hvplot.duckdb` instead. |
 | `FutureWarning` since `0.12.0` | `debug` argument |
 

hvplot/converter.py

@@ -361,6 +361,9 @@ class HoloViewsConverter:
         include all columns (including indexes if ``use_index=True``).
     hover_formatters : dict or None, default=None
         A dict of formatting options for the hover tooltip.
+
+        .. deprecated 0.12
+        User ``hover_tooltips`` instead.
     hover_tooltips : list[str] or list[tuple] or None, default=None
         A list of dimensions to be displayed in the hover tooltip.
     toolbar : str or bool or None, optional
@@ -1151,6 +1154,12 @@ def __init__(
             if hover_tooltips:
                 plot_opts['hover_tooltips'] = hover_tooltips
             if hover_formatters:
+                warnings.warn(
+                    'hover_formatters has been deprecated and will be removed '
+                    'in a future version. Use hover_tooltips instead.',
+                    DeprecationWarning,
+                    stacklevel=_find_stack_level(),
+                )
                 plot_opts['hover_formatters'] = hover_formatters
         if toolbar is not _Undefined:
             if toolbar is False:

hvplot/tests/testdeprecations.py

@@ -22,3 +22,9 @@ def test_plotting_plot_duckdb():
     relation = duckdb.from_df(makeDataFrame(), connection=connection)
     with pytest.warns(FutureWarning):
         plot(relation, 'line')
+
+
+def test_converter_argument_hover_formatters():
+    df = pd.DataFrame({'x': [0, 1], 'y': [0, 1]})
+    with pytest.warns(DeprecationWarning):
+        HoloViewsConverter(df, 'x', 'y', hover_formatters={'@{y}': 'printf'})