mirrors/discord.py
1
0
Fork 0
mirror of https://github.com/Rapptz/discord.py.git synced 2025-06-07 20:28:38 +00:00
Code Issues Projects Releases Wiki Activity

Documentation fixes to quiet Sphinx warnings.

Browse Source
This commit is contained in:
Rapptz 2016-01-07 00:21:00 -05:00
parent 2fd63fc3dd
commit e88bc28236
4 changed files with 8 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
discord/client.py
View File

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

2
discord/utils.py
View File

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

5
docs/api.rst
View File

@ -442,12 +442,13 @@ Some classes are just there to be data containers, this lists them.
.. warning:: .. 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 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 to this rule is :class:`Object` which was designed with dynamic attributes in
mind. 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 Object
~~~~~~~ ~~~~~~~

2
docs/migrating.rst
View File

@ -237,7 +237,7 @@ The following parameters are now exclusively keyword arguments:
- ``allow`` - ``allow``
- ``deny`` - ``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. in the function signature.
.. _migrating-running: .. _migrating-running: