Skip to content

Commit f5d8446

Browse files
authored
docs: make username propriety more findable (#493)
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. Co-authored-by: Danilo Rezende <[email protected]>
1 parent 8772b61 commit f5d8446

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

twitchio/user.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ class PartialUser:
8888
id: str | int
8989
The user's ID.
9090
name: str | None
91-
The user's name. In most cases, this is provided. There are however, rare cases where it is not.
91+
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.
9292
display_name: str | None
9393
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.
9494
"""
@@ -3459,7 +3459,7 @@ class User(PartialUser):
34593459
id: str
34603460
The user's ID.
34613461
name: str | None
3462-
The user's name. In most cases, this is provided. There are however, rare cases where it is not.
3462+
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.
34633463
display_name: str
34643464
The display name of the user.
34653465
type: Literal["admin", "global_mod", "staff", ""]

0 commit comments

Comments
 (0)