diff options
| author | Juan Luis Cano RodrÃguez <hello@juanlu.space> | 2021-09-13 15:23:19 +0200 |
|---|---|---|
| committer | Juan Luis Cano RodrÃguez <hello@juanlu.space> | 2021-09-13 15:23:19 +0200 |
| commit | 1677f416bc3f274694c705d26554eefe2484ed10 (patch) | |
| tree | 4cbe2b2b44832fcdc41984962d17ed3463075bb0 /doc/tutorial | |
| parent | 87b8a0b211cfee05dd95a01857eb65803c24adf7 (diff) | |
| download | sphinx-git-1677f416bc3f274694c705d26554eefe2484ed10.tar.gz | |
Point readers to info field lists instead
Diffstat (limited to 'doc/tutorial')
| -rw-r--r-- | doc/tutorial/describing-code.rst | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/doc/tutorial/describing-code.rst b/doc/tutorial/describing-code.rst index df7418575..bf6660b93 100644 --- a/doc/tutorial/describing-code.rst +++ b/doc/tutorial/describing-code.rst @@ -47,7 +47,7 @@ Notice several things: - Sphinx parsed the argument of the ``.. py:function`` directive and highlighted the module, the function name, and the parameters appropriately. - The directive content includes a one-line description of the function, - as well as a :ref:`field list <rst-field-lists>` containing the function + as well as a :ref:`info field list <info-field-lists>` containing the function parameter, its expected type, the return value, and the return type. .. note:: |