[Docs] Fix user parameter to predicates being typed as discord.TextChannel (#2914)

This commit is contained in:
Flame442 2019-08-17 19:05:22 -04:00 committed by Toby Harradine
parent b1ccfab6d2
commit dfb4212d43
2 changed files with 20 additions and 19 deletions

View File

@ -0,0 +1 @@
Fixed user parameter being labeled as discord.TextChannel instead of discord.abc.User.

View File

@ -78,7 +78,7 @@ class MessagePredicate(Callable[[discord.Message], bool]):
The channel we expect a message in. If unspecified,
defaults to ``ctx.channel``. If ``ctx`` is unspecified
too, the message's channel will be ignored.
user : Optional[discord.TextChannel]
user : Optional[discord.abc.User]
The user we expect a message from. If unspecified,
defaults to ``ctx.author``. If ``ctx`` is unspecified
too, the message's author will be ignored.
@ -113,7 +113,7 @@ class MessagePredicate(Callable[[discord.Message], bool]):
Same as ``ctx`` in :meth:`same_context`.
channel : Optional[discord.TextChannel]
Same as ``channel`` in :meth:`same_context`.
user : Optional[discord.TextChannel]
user : Optional[discord.abc.User]
Same as ``user`` in :meth:`same_context`.
Returns
@ -145,7 +145,7 @@ class MessagePredicate(Callable[[discord.Message], bool]):
Same as ``ctx`` in :meth:`same_context`.
channel : Optional[discord.TextChannel]
Same as ``channel`` in :meth:`same_context`.
user : Optional[discord.TextChannel]
user : Optional[discord.abc.User]
Same as ``user`` in :meth:`same_context`.
Returns
@ -187,7 +187,7 @@ class MessagePredicate(Callable[[discord.Message], bool]):
Same as ``ctx`` in :meth:`same_context`.
channel : Optional[discord.TextChannel]
Same as ``channel`` in :meth:`same_context`.
user : Optional[discord.TextChannel]
user : Optional[discord.abc.User]
Same as ``user`` in :meth:`same_context`.
Returns
@ -227,7 +227,7 @@ class MessagePredicate(Callable[[discord.Message], bool]):
Same as ``ctx`` in :meth:`same_context`.
channel : Optional[discord.TextChannel]
Same as ``channel`` in :meth:`same_context`.
user : Optional[discord.TextChannel]
user : Optional[discord.abc.User]
Same as ``user`` in :meth:`same_context`.
Returns
@ -267,7 +267,7 @@ class MessagePredicate(Callable[[discord.Message], bool]):
Same as ``ctx`` in :meth:`same_context`.
channel : Optional[discord.TextChannel]
Same as ``channel`` in :meth:`same_context`.
user : Optional[discord.TextChannel]
user : Optional[discord.abc.User]
Same as ``user`` in :meth:`same_context`.
Returns
@ -313,7 +313,7 @@ class MessagePredicate(Callable[[discord.Message], bool]):
Same as ``ctx`` in :meth:`same_context`.
channel : Optional[discord.TextChannel]
Same as ``channel`` in :meth:`same_context`.
user : Optional[discord.TextChannel]
user : Optional[discord.abc.User]
Same as ``user`` in :meth:`same_context`.
Returns
@ -357,7 +357,7 @@ class MessagePredicate(Callable[[discord.Message], bool]):
Same as ``ctx`` in :meth:`same_context`.
channel : Optional[discord.TextChannel]
Same as ``channel`` in :meth:`same_context`.
user : Optional[discord.TextChannel]
user : Optional[discord.abc.User]
Same as ``user`` in :meth:`same_context`.
Returns
@ -405,7 +405,7 @@ class MessagePredicate(Callable[[discord.Message], bool]):
Same as ``ctx`` in :meth:`same_context`.
channel : Optional[discord.TextChannel]
Same as ``channel`` in :meth:`same_context`.
user : Optional[discord.TextChannel]
user : Optional[discord.abc.User]
Same as ``user`` in :meth:`same_context`.
Returns
@ -454,7 +454,7 @@ class MessagePredicate(Callable[[discord.Message], bool]):
Same as ``ctx`` in :meth:`same_context`.
channel : Optional[discord.TextChannel]
Same as ``channel`` in :meth:`same_context`.
user : Optional[discord.TextChannel]
user : Optional[discord.abc.User]
Same as ``user`` in :meth:`same_context`.
Returns
@ -503,7 +503,7 @@ class MessagePredicate(Callable[[discord.Message], bool]):
Same as ``ctx`` in :meth:`same_context`.
channel : Optional[discord.TextChannel]
Same as ``channel`` in :meth:`same_context`.
user : Optional[discord.TextChannel]
user : Optional[discord.abc.User]
Same as ``user`` in :meth:`same_context`.
Returns
@ -533,7 +533,7 @@ class MessagePredicate(Callable[[discord.Message], bool]):
Same as ``ctx`` in :meth:`same_context`.
channel : Optional[discord.TextChannel]
Same as ``channel`` in :meth:`same_context`.
user : Optional[discord.TextChannel]
user : Optional[discord.abc.User]
Same as ``user`` in :meth:`same_context`.
Returns
@ -563,7 +563,7 @@ class MessagePredicate(Callable[[discord.Message], bool]):
Same as ``ctx`` in :meth:`same_context`.
channel : Optional[discord.TextChannel]
Same as ``channel`` in :meth:`same_context`.
user : Optional[discord.TextChannel]
user : Optional[discord.abc.User]
Same as ``user`` in :meth:`same_context`.
Returns
@ -594,7 +594,7 @@ class MessagePredicate(Callable[[discord.Message], bool]):
Same as ``ctx`` in :meth:`same_context`.
channel : Optional[discord.TextChannel]
Same as ``channel`` in :meth:`same_context`.
user : Optional[discord.TextChannel]
user : Optional[discord.abc.User]
Same as ``user`` in :meth:`same_context`.
Returns
@ -625,7 +625,7 @@ class MessagePredicate(Callable[[discord.Message], bool]):
Same as ``ctx`` in :meth:`same_context`.
channel : Optional[discord.TextChannel]
Same as ``channel`` in :meth:`same_context`.
user : Optional[discord.TextChannel]
user : Optional[discord.abc.User]
Same as ``user`` in :meth:`same_context`.
Returns
@ -655,7 +655,7 @@ class MessagePredicate(Callable[[discord.Message], bool]):
Same as ``ctx`` in :meth:`same_context`.
channel : Optional[discord.TextChannel]
Same as ``channel`` in :meth:`same_context`.
user : Optional[discord.TextChannel]
user : Optional[discord.abc.User]
Same as ``user`` in :meth:`same_context`.
Returns
@ -688,7 +688,7 @@ class MessagePredicate(Callable[[discord.Message], bool]):
Same as ``ctx`` in :meth:`same_context`.
channel : Optional[discord.TextChannel]
Same as ``channel`` in :meth:`same_context`.
user : Optional[discord.TextChannel]
user : Optional[discord.abc.User]
Same as ``user`` in :meth:`same_context`.
Returns
@ -729,7 +729,7 @@ class MessagePredicate(Callable[[discord.Message], bool]):
Same as ``ctx`` in :meth:`same_context`.
channel : Optional[discord.TextChannel]
Same as ``channel`` in :meth:`same_context`.
user : Optional[discord.TextChannel]
user : Optional[discord.abc.User]
Same as ``user`` in :meth:`same_context`.
Returns
@ -774,7 +774,7 @@ class MessagePredicate(Callable[[discord.Message], bool]):
Same as ``ctx`` in :meth:`same_context`.
channel : Optional[discord.TextChannel]
Same as ``channel`` in :meth:`same_context`.
user : Optional[discord.TextChannel]
user : Optional[discord.abc.User]
Same as ``user`` in :meth:`same_context`.
Returns