IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

doc: Add a note for var, ivar and cvar

Browse Source
This commit is contained in:
Takeshi KOMIYA 2016-12-17 14:46:39 +09:00
parent 3b9d83e15e
commit 1ccfb9736b
1 changed files with 5 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
doc/domains.rst
View File

@ -318,6 +318,11 @@ are recognized and formatted nicely:
* ``returns``, ``return``: Description of the return value.
* ``rtype``: Return type. Creates a link if possible.
.. note::
In current release, all ``var``, ``ivar`` and ``cvar`` are represented as "Variable".
There is no difference at all.
The field names must consist of one of these keywords and an argument (except
for ``returns`` and ``rtype``, which do not need an argument). This is best
explained by an example::