Skip to content

Commit c9921fc

Browse files
committed
Correct return type of Context.get_user()
Correct return type of Context.get_user() to PartialChatter / Chatter
1 parent 8a2a839 commit c9921fc

File tree

2 files changed

+11
-5
lines changed

2 files changed

+11
-5
lines changed

docs/changelog.rst

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,19 @@
11
:orphan:
22

3+
2.9.3
4+
=======
5+
- ext.commands
6+
- Bug fixes
7+
- Fixed return type of :func:`~twitchio.ext.commands.Context.get_user` to PartialChatter / Chatter from PartialUser / User.
8+
39
2.9.2
410
=======
511
- TwitchIO
612
- Changes:
7-
- :func:`PartialUser.fetch_moderated_channels <twitchio.PartialUser.fetch_moderated_channels>` returns "broadcaster_login" api field instead of "broadcaster_name"
13+
- :func:`~twitchio.PartialUser.fetch_moderated_channels` returns "broadcaster_login" api field instead of "broadcaster_name"
814

915
- Bug fixes
10-
- fix: :func:`PartialUser.fetch_moderated_channels <twitchio.PartialUser.fetch_moderated_channels>` used "user_" prefix from payload, now uses "broadcaster_" instead
16+
- fix: :func:`~twitchio.PartialUser.fetch_moderated_channels` used ``user_`` prefix from payload, now uses ``broadcaster_`` instead
1117

1218

1319
2.9.1

twitchio/ext/commands/core.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -575,7 +575,7 @@ def users(self) -> Optional[Set[Chatter]]: # Alias to chatters
575575
"""Alias to chatters."""
576576
return self.chatters
577577

578-
def get_user(self, name: str) -> Optional[Union[PartialUser, User]]:
578+
def get_user(self, name: str) -> Optional[Union[PartialChatter, Chatter]]:
579579
"""Retrieve a user from the channels user cache.
580580
581581
Parameters
@@ -585,8 +585,8 @@ def get_user(self, name: str) -> Optional[Union[PartialUser, User]]:
585585
586586
Returns
587587
--------
588-
Union[:class:`twitchio.user.User`, :class:`twitchio.user.PartialUser`]
589-
Could be a :class:`twitchio.user.PartialUser` depending on how the user joined the channel.
588+
Union[:class:`twitchio.Chatter`, :class:`twitchio.PartialChatter`]
589+
Could be a :class:`twitchio.PartialChatter` depending on how the user joined the channel.
590590
Returns None if no user was found.
591591
"""
592592
name = name.lower()

0 commit comments

Comments
 (0)