Browse Source

Documentation fixes to quiet Sphinx warnings.

pull/77/head
Rapptz 9 years ago
parent
commit
e88bc28236
  1. 6
      discord/client.py
  2. 2
      discord/utils.py
  3. 5
      docs/api.rst
  4. 2
      docs/migrating.rst

6
discord/client.py

@ -2069,7 +2069,7 @@ class Client:
-----------
member : :class:`Member`
The member to give roles to.
*roles
\*roles
An argument list of :class:`Role` s to give the member.
Raises
@ -2097,7 +2097,7 @@ class Client:
-----------
member : :class:`Member`
The member to revoke roles from.
*roles
\*roles
An argument list of :class:`Role` s to revoke the member.
Raises
@ -2137,7 +2137,7 @@ class Client:
-----------
member : :class:`Member`
The member to replace roles from.
*roles
\*roles
An argument list of :class:`Role` s to replace the roles with.
Raises

2
discord/utils.py

@ -141,7 +141,7 @@ def get(iterable, **attrs):
-----------
iterable
An iterable to search through.
**attrs
\*\*attrs
Keyword arguments that denote attributes to search with.
"""

5
docs/api.rst

@ -442,12 +442,13 @@ Some classes are just there to be data containers, this lists them.
.. warning::
Nearly all data classes here have `__slots__` defined which means that it is
Nearly all data classes here have ``__slots__`` defined which means that it is
impossible to have dynamic attributes to the data classes. The only exception
to this rule is :class:`Object` which was designed with dynamic attributes in
mind.
More information about `__slots__` can be found `in the official python documentation <https://docs.python.org/3/reference/datamodel.html#slots>`.
More information about ``__slots__`` can be found
`in the official python documentation <https://docs.python.org/3/reference/datamodel.html#slots>`_.
Object
~~~~~~~

2
docs/migrating.rst

@ -237,7 +237,7 @@ The following parameters are now exclusively keyword arguments:
- ``allow``
- ``deny``
In the documentation you can tell if a function parameter is a forced keyword argument if it is after ``*, ``
In the documentation you can tell if a function parameter is a forced keyword argument if it is after ``\*,``
in the function signature.
.. _migrating-running:

Loading…
Cancel
Save