diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/api.rst | 5 |
1 files changed, 3 insertions, 2 deletions
diff --git a/docs/api.rst b/docs/api.rst index 3463e2f8..d5dc0e2f 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -251,10 +251,11 @@ to handle it, which defaults to print a traceback and ignore the exception. Called when someone begins typing a message. The ``channel`` parameter could either be a :class:`PrivateChannel` or a - :class:`Channel`. + :class:`Channel`. If ``channel`` is a :class:`PrivateChannel` then the + ``user`` parameter is a :class:`User`, otherwise it is a :class:`Member`. :param channel: The location where the typing originated from. - :param user: The :class:`Member` that started typing. + :param user: The user that started typing. :param when: A ``datetime.datetime`` object representing when typing started. |