diff options
| author | Rapptz <[email protected]> | 2016-01-07 00:21:00 -0500 |
|---|---|---|
| committer | Rapptz <[email protected]> | 2016-01-07 00:21:00 -0500 |
| commit | e88bc28236c75f589333ae1d41d5f76e6c1a868b (patch) | |
| tree | f4316b4f810a557ee433c7518cc3f2c9e043872b /docs | |
| parent | Document the fact that data classes use __slots__. (diff) | |
| download | discord.py-e88bc28236c75f589333ae1d41d5f76e6c1a868b.tar.xz discord.py-e88bc28236c75f589333ae1d41d5f76e6c1a868b.zip | |
Documentation fixes to quiet Sphinx warnings.
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/api.rst | 5 | ||||
| -rw-r--r-- | docs/migrating.rst | 2 |
2 files changed, 4 insertions, 3 deletions
diff --git a/docs/api.rst b/docs/api.rst index b022f298..17c0f7ed 100644 --- a/docs/api.rst +++ b/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 ~~~~~~~ diff --git a/docs/migrating.rst b/docs/migrating.rst index cd973e9f..caf15d67 100644 --- a/docs/migrating.rst +++ b/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: |