Document how decorated functions are modified

delivrance · delivrance · commit 6a9c7312ccf6 · 2018-12-15T09:10:19.000+01:00
diff --git a/pyrogram/client/methods/decorators/on_callback_query.py b/pyrogram/client/methods/decorators/on_callback_query.py
@@ -27,6 +27,13 @@ def on_callback_query(self=None, filters=None, group: int = 0):
         callback queries. This does the same thing as :meth:`add_handler` using the
         :class:`CallbackQueryHandler`.
 
+        .. note::
+            This decorator will wrap your defined function in a tuple consisting of *(Handler, group)*.
+
+            To reference your own function after it has been decorated, you need to access
+            *my_function[0].callback*, that is, the *callback* field of Handler object which is the the
+            first element in the tuple.
+
         Args:
             filters (:obj:`Filters <pyrogram.Filters>`):
                 Pass one or more filters to allow only a subset of callback queries to be passed
diff --git a/pyrogram/client/methods/decorators/on_deleted_messages.py b/pyrogram/client/methods/decorators/on_deleted_messages.py
@@ -27,6 +27,13 @@ def on_deleted_messages(self=None, filters=None, group: int = 0):
         deleted messages. This does the same thing as :meth:`add_handler` using the
         :class:`DeletedMessagesHandler`.
 
+        .. note::
+            This decorator will wrap your defined function in a tuple consisting of *(Handler, group)*.
+
+            To reference your own function after it has been decorated, you need to access
+            *my_function[0].callback*, that is, the *callback* field of Handler object which is the the
+            first element in the tuple.
+
         Args:
             filters (:obj:`Filters <pyrogram.Filters>`):
                 Pass one or more filters to allow only a subset of messages to be passed
diff --git a/pyrogram/client/methods/decorators/on_message.py b/pyrogram/client/methods/decorators/on_message.py
@@ -27,6 +27,13 @@ def on_message(self=None, filters=None, group: int = 0):
         messages. This does the same thing as :meth:`add_handler` using the
         :class:`MessageHandler`.
 
+        .. note::
+            This decorator will wrap your defined function in a tuple consisting of *(Handler, group)*.
+
+            To reference your own function after it has been decorated, you need to access
+            *my_function[0].callback*, that is, the *callback* field of Handler object which is the the
+            first element in the tuple.
+
         Args:
             filters (:obj:`Filters <pyrogram.Filters>`):
                 Pass one or more filters to allow only a subset of messages to be passed
diff --git a/pyrogram/client/methods/decorators/on_raw_update.py b/pyrogram/client/methods/decorators/on_raw_update.py
@@ -26,6 +26,13 @@ def on_raw_update(self=None, group: int = 0):
         raw updates. This does the same thing as :meth:`add_handler` using the
         :class:`RawUpdateHandler`.
 
+        .. note::
+            This decorator will wrap your defined function in a tuple consisting of *(Handler, group)*.
+
+            To reference your own function after it has been decorated, you need to access
+            *my_function[0].callback*, that is, the *callback* field of Handler object which is the the
+            first element in the tuple.
+
         Args:
             group (``int``, *optional*):
                 The group identifier, defaults to 0.
diff --git a/pyrogram/client/methods/decorators/on_user_status.py b/pyrogram/client/methods/decorators/on_user_status.py
@@ -27,6 +27,13 @@ def on_user_status(self=None, filters=None, group: int = 0):
         user status updates. This does the same thing as :meth:`add_handler` using the
         :class:`UserStatusHandler`.
 
+        .. note::
+            This decorator will wrap your defined function in a tuple consisting of *(Handler, group)*.
+
+            To reference your own function after it has been decorated, you need to access
+            *my_function[0].callback*, that is, the *callback* field of Handler object which is the the
+            first element in the tuple.
+
         Args:
             filters (:obj:`Filters <pyrogram.Filters>`):
                 Pass one or more filters to allow only a subset of UserStatus updated to be passed in your function.
