From e88bc28236c75f589333ae1d41d5f76e6c1a868b Mon Sep 17 00:00:00 2001 From: Rapptz Date: Thu, 7 Jan 2016 00:21:00 -0500 Subject: Documentation fixes to quiet Sphinx warnings. --- docs/api.rst | 5 +++-- docs/migrating.rst | 2 +- 2 files changed, 4 insertions(+), 3 deletions(-) (limited to 'docs') 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 `. + More information about ``__slots__`` can be found + `in the official python documentation `_. 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: -- cgit v1.2.3