mirrors/discord.py
1
0
Fork 0
mirror of https://github.com/Rapptz/discord.py.git synced 2025-09-07 18:33:02 +00:00
Code Issues Projects Releases Wiki Activity

Use describe instead of tables for supported operations.

Browse Source
This commit is contained in:
Rapptz
2017-05-13 18:48:14 -04:00
parent 96eca8aa53
commit f73eb087c9
9 changed files with 206 additions and 168 deletions
Download Patch File Download Diff File Expand all files Collapse all files

36
discord/emoji.py
View File

@ -38,24 +38,26 @@ class Emoji(Hashable):
Depending on the way this object was created, some of the attributes can
have a value of ``None``.
Supported Operations:
.. describe:: x == y
+-----------+-----------------------------------------+
| Operation | Description |
+===========+=========================================+
| x == y | Checks if two emoji are the same. |
+-----------+-----------------------------------------+
| x != y | Checks if two emoji are not the same. |
+-----------+-----------------------------------------+
| hash(x) | Return the emoji's hash. |
+-----------+-----------------------------------------+
| iter(x) | Returns an iterator of (field, value) |
| | pairs. This allows this class to be |
| | used as an iterable in list/dict/etc. |
| | constructions. |
+-----------+-----------------------------------------+
| str(x) | Returns the emoji rendered for discord. |
+-----------+-----------------------------------------+
Checks if two emoji are the same.
.. describe:: x != y
Checks if two emoji are not the same.
.. describe:: hash(x)
Return the emoji's hash.
.. describe:: iter(x)
Returns an iterator of ``(field, value)`` pairs. This allows this class
to be used as an iterable in list/dict/etc constructions.
.. describe:: str(x)
Returns the emoji rendered for discord.
Attributes
-----------