Minor fixes.
bzr revid: daniel@daniel-watkins.co.uk-20110414214530-767qdh3ygh8kxkpj
This commit is contained in:
parent
9c99f01964
commit
c6b812ebfa
|
@ -31,7 +31,7 @@ Guides and main documentation
|
||||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
The meat and most important part of all documentation. Should be
|
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`_.
|
of `Sphinx's extensions`_, especially `cross-references`_.
|
||||||
|
|
||||||
Python API Documentation
|
Python API Documentation
|
||||||
|
@ -65,7 +65,7 @@ RST, using Sphinx's `Python domain`_ [#]_:
|
||||||
and ``__new__``), using the `info fields`_ as well.
|
and ``__new__``), using the `info fields`_ as well.
|
||||||
|
|
||||||
* Attributes (class and instance) should be documented in their
|
* 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 class's own documentation.
|
||||||
|
|
||||||
* The relation between modules and module-level attributes is similar:
|
* The relation between modules and module-level attributes is similar:
|
||||||
|
@ -220,7 +220,7 @@ Roadmap
|
||||||
Release notes
|
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.
|
is optional and should be left out.
|
||||||
|
|
||||||
.. [#] Resig's Class still uses prototypes under the hood, it doesn't
|
.. [#] Resig's Class still uses prototypes under the hood, it doesn't
|
||||||
|
|
Loading…
Reference in New Issue