Skip to content

Commit 1fed1aa

Browse files
committed
Added doc strings
1 parent 8e4c309 commit 1fed1aa

File tree

2 files changed

+23
-0
lines changed

2 files changed

+23
-0
lines changed

discord/user.py

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -84,6 +84,7 @@
8484
'User',
8585
'ClientUser',
8686
'RecentAvatar',
87+
'DisplayNameStyle',
8788
)
8889

8990

@@ -92,6 +93,19 @@ class _UserTag:
9293
id: int
9394

9495
class DisplayNameStyle:
96+
"""Represents a user's display name style.
97+
98+
Attributes
99+
-----------
100+
font: :class:`NameFont`
101+
The font used for the display name.
102+
effect: :class:`NameEffect`
103+
The visual effect applied to the display name.
104+
colors: List[:class:`Colour`]
105+
The list of colours applied to the display name.
106+
107+
.. versionadded:: 2.1
108+
"""
95109
def __init__(self, *, data: DisplayNameStylePayload) -> None:
96110
self.font: NameFont = try_enum(NameFont, data['font_id'])
97111
self.effect: NameEffect = try_enum(NameEffect, data['effect_id'])
@@ -401,6 +415,10 @@ def primary_guild(self) -> PrimaryGuild:
401415

402416
@property
403417
def display_name_style(self) -> Optional[DisplayNameStyle]:
418+
""":class:`DisplayNameStyle`: Returns the user's display name style.
419+
420+
.. versionadded:: 2.1
421+
"""
404422
if self._display_name_style is None:
405423
return None
406424
return DisplayNameStyle(data=self._display_name_style)

docs/api.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7381,6 +7381,11 @@ User
73817381
.. autoclass:: PrimaryGuild()
73827382
:members:
73837383

7384+
.. attributetable:: DisplayNameStyle
7385+
7386+
.. autoclass:: DisplayNameStyle()
7387+
:members:
7388+
73847389
Affinity
73857390
~~~~~~~~~
73867391

0 commit comments

Comments
 (0)