Update bind_hass docstring to discourage its use (#96933)

2023-07-20 13:34:24 +02:00 · 2023-07-20 13:34:24 +02:00 · f809ce9033
parent 14b553ddbc
commit f809ce9033
1 changed files with 5 additions and 1 deletions
--- a/homeassistant/loader.py
+++ b/homeassistant/loader.py
@ -1098,7 +1098,11 @@ class Helpers:


 def bind_hass(func: _CallableT) -> _CallableT:
-    """Decorate function to indicate that first argument is hass."""
+    """Decorate function to indicate that first argument is hass.
+
+    The use of this decorator is discouraged, and it should not be used
+    for new functions.
+    """
    setattr(func, "__bind_hass", True)
    return func