aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRapptz <[email protected]>2015-12-16 22:20:54 -0500
committerRapptz <[email protected]>2015-12-16 22:20:54 -0500
commit9f925364412093381f50c0ca48f50d249da939c2 (patch)
tree7461113e4b5f734a793e7c66d4ed217da9421d73
parentMake more things into properties. (diff)
downloaddiscord.py-9f925364412093381f50c0ca48f50d249da939c2.tar.xz
discord.py-9f925364412093381f50c0ca48f50d249da939c2.zip
Clean-up documentation to use NumPy style docs on remaining classes.
-rw-r--r--discord/message.py62
-rw-r--r--discord/object.py2
-rw-r--r--discord/user.py2
-rw-r--r--discord/utils.py11
4 files changed, 35 insertions, 42 deletions
diff --git a/discord/message.py b/discord/message.py
index 496cd75e..f4ff0586 100644
--- a/discord/message.py
+++ b/discord/message.py
@@ -35,41 +35,33 @@ class Message(object):
There should be no need to create one of these manually.
- Instance attributes:
-
- .. attribute:: edited_timestamp
-
- A naive UTC datetime object containing the edited time of the message. Could be None.
- .. attribute:: timestamp
-
+ Attributes
+ -----------
+ edited_timestamp : Optional[datetime.datetime]
+ A naive UTC datetime object containing the edited time of the message.
+ timestamp : datetime.datetime
A naive UTC datetime object containing the time the message was created.
- .. attribute:: tts
-
- A boolean specifying if the message was done with text-to-speech.
- .. attribute:: author
-
- A :class:`Member` that sent the message. If :attr:`channel` is a private channel,
- then it is a :class:`User` instead.
- .. attribute:: content
-
+ tts : bool
+ Specifies if the message was done with text-to-speech.
+ author
+ A :class:`Member` that sent the message. If :attr:`channel` is a
+ private channel, then it is a :class:`User` instead.
+ content : str
The actual contents of the message.
- .. attribute:: embeds
-
+ embeds : list
A list of embedded objects. The elements are objects that meet oEmbed's specification_.
.. _specification: http://oembed.com/
- .. attribute:: channel
-
- The :class:`Channel` that the message was sent from. Could be a :class:`PrivateChannel` if it's a private message.
+ channel
+ The :class:`Channel` that the message was sent from.
+ Could be a :class:`PrivateChannel` if it's a private message.
In :issue:`very rare cases <21>` this could be a :class:`Object` instead.
For the sake of convenience, this :class:`Object` instance has an attribute ``is_private`` set to ``True``.
- .. attribute:: server
-
- The :class:`Server` that the message belongs to. If not applicable (i.e. a PM) then it's None instead.
- .. attribute:: mention_everyone
-
- A boolean specifying if the message mentions everyone.
+ server : Optional[:class:`Server`]
+ The server that the message belongs to. If not applicable (i.e. a PM) then it's None instead.
+ mention_everyone : bool
+ Specifies if the message mentions everyone.
.. note::
@@ -77,8 +69,7 @@ class Message(object):
Rather this boolean indicates if the ``@everyone`` text is in the message
**and** it did end up mentioning everyone.
- .. attribute:: mentions
-
+ mentions : list
A list of :class:`Member` that were mentioned. If the message is in a private message
then the list is always empty.
@@ -87,15 +78,12 @@ class Message(object):
The order of the mentions list is not in any particular order so you should
not rely on it. This is a discord limitation, not one with the library.
- .. attribute:: channel_mentions
-
+ channel_mentions : list
A list of :class:`Channel` that were mentioned. If the message is in a private message
then the list is always empty.
- .. attribute:: id
-
+ id : str
The message ID.
- .. attribute:: attachments
-
+ attachments : list
A list of attachments given to a message.
"""
@@ -114,7 +102,7 @@ class Message(object):
self.channel = kwargs.get('channel')
self.author = User(**kwargs.get('author', {}))
self.attachments = kwargs.get('attachments')
- self._handle_upgrades_and_server(kwargs.get('channel_id'))
+ self._handle_upgrades(kwargs.get('channel_id'))
self._handle_mentions(kwargs.get('mentions', []))
def _handle_mentions(self, mentions):
@@ -156,7 +144,7 @@ class Message(object):
"""
return re.findall(r'<#(\d+)>', self.content)
- def _handle_upgrades_and_server(self, channel_id):
+ def _handle_upgrades(self, channel_id):
self.server = None
if self.channel is None:
if channel_id is not None:
diff --git a/discord/object.py b/discord/object.py
index d073ef15..ebf28f0f 100644
--- a/discord/object.py
+++ b/discord/object.py
@@ -23,7 +23,7 @@ FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE.
"""
-class Object(object):
+class Object:
"""Represents a generic Discord object.
The purpose of this class is to allow you to create 'miniature'
diff --git a/discord/user.py b/discord/user.py
index 455fca14..a5ef2edb 100644
--- a/discord/user.py
+++ b/discord/user.py
@@ -24,7 +24,7 @@ FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE.
"""
-class User(object):
+class User:
"""Represents a Discord user.
Supported Operations:
diff --git a/discord/utils.py b/discord/utils.py
index 9e230262..1629a454 100644
--- a/discord/utils.py
+++ b/discord/utils.py
@@ -58,15 +58,20 @@ def find(predicate, seq):
member = find(lambda m: m.name == 'Mighty', channel.server.members)
would find the first :class:`Member` whose name is 'Mighty' and return it.
+ If an entry is not found, then ``None`` is returned.
This is different from `filter`_ due to the fact it stops the moment it finds
a valid entry.
+
.. _filter: https://docs.python.org/3.6/library/functions.html#filter
- :param predicate: A function that returns a boolean-like result.
- :param seq: The sequence to iterate through.
- :return: The first result of the predicate that returned a ``True``-like value or ``None`` if nothing was found.
+ Parameters
+ -----------
+ predicate
+ A function that returns a boolean-like result.
+ seq : iterable
+ The iterable to search through.
"""
for element in seq: