Xtao-Labs/MTPyroger
3
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Fix filters.create documentation (#623)

Browse Source 
Wrong documentation for filters.create, callable funcitions requires 3 positional arguments (filter, client, update) and not two.
This commit is contained in:
Dametto Luca 2021-03-14 12:44:13 +01:00 committed by GitHub
parent f407facdc7
commit 54b20875b9
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
pyrogram/filters.py
View File

@ -127,12 +127,12 @@ def create(func: Callable, name: str = None, **kwargs) -> Filter:
Parameters: Parameters:
func (``callable``): func (``callable``):
A function that accepts two positional arguments *(filter, update)* and returns a boolean: True if the A function that accepts three positional arguments *(filter, client, update)* and returns a boolean: True if the
update should be handled, False otherwise. The *filter* argument refers to the filter itself and can be used update should be handled, False otherwise.
to access keyword arguments (read below). The *update* argument type will vary depending on which The *filter* argument refers to the filter itself and can be used to access keyword arguments (read below).
`Handler <handlers>`_ is coming from. For example, in a :obj:`~pyrogram.handlers.MessageHandler` the The *client* argument refers to the :obj:`~pyrogram.Client` that received the update.
*update* argument will be a :obj:`~pyrogram.types.Message`; in a The *update* argument type will vary depending on which `Handler <handlers>`_ is coming from.
:obj:`~pyrogram.handlers.CallbackQueryHandler` the *update* will be a :obj:`~pyrogram.types.CallbackQuery`. For example, in a :obj:`~pyrogram.handlers.MessageHandler` the *update* argument will be a :obj:`~pyrogram.types.Message`; in a :obj:`~pyrogram.handlers.CallbackQueryHandler` the *update* will be a :obj:`~pyrogram.types.CallbackQuery`.
Your function body can then access the incoming update attributes and decide whether to allow it or not. Your function body can then access the incoming update attributes and decide whether to allow it or not.
name (``str``, *optional*): name (``str``, *optional*):