Skip to content

docs: improve docstring wording for display properties #3163

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
Sim-hu wants to merge 1 commit into from
Closed

docs: improve docstring wording for display properties #3163

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 6 additions & 9 deletions discord/member.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -663,9 +663,8 @@ def display_name(self) -> str:
def display_avatar(self) -> Asset:
"""Returns the member's display avatar.

For regular members this is just their avatar, but
if they have a guild specific avatar then that
is returned instead.
If the member has a guild-specific avatar, that is returned.
Otherwise, their user avatar or default avatar is used.

.. versionadded:: 2.0
"""
Expand All @@ -688,9 +687,8 @@ def guild_avatar(self) -> Asset | None:
def display_avatar_decoration(self) -> Asset | None:
"""Returns the member's displayed avatar decoration.

For regular members this is just their avatar decoration, but
if they have a guild specific avatar decoration then that
is returned instead.
If the member has a guild-specific avatar decoration, that is
returned. Otherwise, their user avatar decoration is used.

.. versionadded:: 2.8
"""
Expand All @@ -713,9 +711,8 @@ def guild_avatar_decoration(self) -> Asset | None:
def display_banner(self) -> Asset | None:
"""Returns the member's display banner.

For regular members this is just their banner, but
if they have a guild specific banner then that
is returned instead.
If the member has a guild-specific banner, that is returned.
Otherwise, their user banner is used.

.. versionadded:: 2.7
"""
Expand Down
3 changes: 2 additions & 1 deletion discord/user.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -251,7 +251,8 @@ def default_avatar(self) -> Asset:
def display_avatar(self) -> Asset:
"""Returns the user's display avatar.

For regular users this is just their default avatar or uploaded avatar.
This is the user's uploaded avatar if available,
otherwise their default avatar.

.. versionadded:: 2.0
"""
Expand Down
Loading