From 3f44569715f555e286c4fcce56115d961181b995 Mon Sep 17 00:00:00 2001 From: Danilo Rezende Date: Tue, 13 May 2025 18:32:09 -0300 Subject: [PATCH] docs: make username propriety more findable For regular twitch users, this propriety is known as `username`, but the helix api definitions refer to as `login name`. This makes it easier to find the relevant twitch api section from reading the twitchio docs, and vice versa. --- twitchio/user.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/twitchio/user.py b/twitchio/user.py index 6d1feee5..58c89913 100644 --- a/twitchio/user.py +++ b/twitchio/user.py @@ -88,7 +88,7 @@ class PartialUser: id: str | int The user's ID. name: str | None - The user's name. In most cases, this is provided. There are however, rare cases where it is not. + The user's name. Also known as *username* or *login name*. In most cases, this is provided. There are however, rare cases where it is not. display_name: str | None The user's display name in chat. In most cases, this is provided otherwise fallsback to `name`. There are however, rare cases where it is not. """ @@ -3459,7 +3459,7 @@ class User(PartialUser): id: str The user's ID. name: str | None - The user's name. In most cases, this is provided. There are however, rare cases where it is not. + The user's name. Also known as *username* or *login name*. In most cases, this is provided. There are however, rare cases where it is not. display_name: str The display name of the user. type: Literal["admin", "global_mod", "staff", ""]