From c6b812ebfad91d9833ba7fe127932da1f49a7be6 Mon Sep 17 00:00:00 2001 From: Daniel Watkins Date: Thu, 14 Apr 2011 22:45:30 +0100 Subject: [PATCH] Minor fixes. bzr revid: daniel@daniel-watkins.co.uk-20110414214530-767qdh3ygh8kxkpj --- doc/source/project.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/doc/source/project.rst b/doc/source/project.rst index 6f9a06b2f0d..d435a731d40 100644 --- a/doc/source/project.rst +++ b/doc/source/project.rst @@ -31,7 +31,7 @@ Guides and main documentation ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ The meat and most important part of all documentation. Should be -written in plain english, using reStructuredText_ and taking advantage +written in plain English, using reStructuredText_ and taking advantage of `Sphinx's extensions`_, especially `cross-references`_. Python API Documentation @@ -65,7 +65,7 @@ RST, using Sphinx's `Python domain`_ [#]_: and ``__new__``), using the `info fields`_ as well. * Attributes (class and instance) should be documented in their - class's docstrin via the ``.. attribute::`` directiveg, following + class's docstring via the ``.. attribute::`` directiveg, following the class's own documentation. * The relation between modules and module-level attributes is similar: @@ -220,7 +220,7 @@ Roadmap Release notes +++++++++++++ -.. [#] because Python is the default domain, the ``py:`` markup prefix +.. [#] Because Python is the default domain, the ``py:`` markup prefix is optional and should be left out. .. [#] Resig's Class still uses prototypes under the hood, it doesn't