diff options
| author | Xavier Morel <xmo@openerp.com> | 2011-03-27 15:59:00 +0200 |
|---|---|---|
| committer | Xavier Morel <xmo@openerp.com> | 2011-03-27 15:59:00 +0200 |
| commit | 91d620c3280b32d7ccf37e4e2c03a3bb2749f97f (patch) | |
| tree | 36ee68d65ce317e4bde8e1bbbc3bc27d38614aa8 /doc | |
| parent | 8b485e7b528945ad9979660a872c77783867fe9b (diff) | |
[IMP] Sphinx will automatically cross-reference return types it understands, for direct class references no need to manually cross-ref
bzr revid: xmo@openerp.com-20110327135900-wqk5ow1m4zavnwvg
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/source/project.rst | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/doc/source/project.rst b/doc/source/project.rst index 5ef06a7280a..8c933e25028 100644 --- a/doc/source/project.rst +++ b/doc/source/project.rst @@ -51,14 +51,14 @@ RST, using Sphinx's `Python domain`_ [#]_: unless a more extensive explanation needs to be given (e.g. the specification that the input should be a list of 3-tuple needs to use ``:type:`` even though all types involved are built-ins). Any - other type should be specified in full with a cross-reference using - the ``:type:`` field:: + other type should be specified in full using the ``:type:`` field:: :param foo: what the purpose of foo is - :type foo: :class:`some.addon.Class` + :type foo: some.addon.Class - Likewise, mentions of other methods (including within the same - class), modules or types should be cross-referenced. + Mentions of other methods (including within the same class), modules + or types in descriptions (of anything, including parameters) should + be cross-referenced. * Classes should likewise be documented using their own docstring, and should include the documentation of their construction (``__init__`` |