From abd966aa775baa51b08db8d524f57d383861d4f7 Mon Sep 17 00:00:00 2001 From: "Nathaniel J. Smith" Date: Fri, 12 May 2017 00:30:16 -0700 Subject: [PATCH] words --- README.rst | 6 +++--- docs/source/index.rst | 8 ++++---- 2 files changed, 7 insertions(+), 7 deletions(-) diff --git a/README.rst b/README.rst index daea365..e170829 100644 --- a/README.rst +++ b/README.rst @@ -32,9 +32,9 @@ https://github.com/python-trio/sphinxcontrib-trio **Usage:** ``pip install -U sphinxcontrib-trio`` in the same environment where you installed sphinx, and then add ``"sphinxcontrib_trio"`` to the list of ``extensions`` in your -project's ``conf.py``. (Note that it's ``sphinxcontrib_trio`` with an -underscore, NOT a dot. This is because I don't understand namespace -packages, and I fear things that I don't understand.) +project's ``conf.py``. (Notice that ``"sphinxcontrib_trio"`` has an +underscore in it, NOT a dot. This is because I don't understand +namespace packages, and I fear things that I don't understand.) **Code of conduct:** Contributors are requested to follow our `code of conduct diff --git a/docs/source/index.rst b/docs/source/index.rst index d31abc1..21b2c06 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -21,7 +21,7 @@ every possible type: ``asyncmethod::``, ``abstractmethod::``, the idea. But this quickly becomes silly. sphinxcontrib-trio takes a different approach: it enhances the basic ``function::`` and ``method::`` directives to accept options describing the attributes of -each function/method, so you can mix and match like: +each function/method, so you can write ReST code like: .. code-block:: rst @@ -32,7 +32,7 @@ each function/method, so you can mix and match like: This method is perhaps more complicated than it needs to be. -and you'll get a rendered output like: +and you'll get rendered output like: .. method:: overachiever(arg1, ...) :abstractmethod: @@ -41,7 +41,7 @@ and you'll get a rendered output like: This method is perhaps more complicated than it needs to be. -And while I was at it, I also enhanced the ``sphinx.ext.autodoc`` +While I was at it, I also enhanced the ``sphinx.ext.autodoc`` directives ``autofunction::`` and ``automethod::`` with new versions that know how to automatically detect many of these attributes, so you could just as easily have written the above as: @@ -63,7 +63,7 @@ alias for: and similarly ``staticmethod``, ``decorator``, and ``decoratormethod``, so dropping this extension into an existing -sphinx project should be 100% backwards-compatible while giving you +sphinx project should be 100% backwards-compatible while giving sphinx new superpowers. Basically, this is how sphinx ought to work in the first