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

Point readers to info field lists instead

Browse Source
This commit is contained in:
Juan Luis Cano Rodríguez
2021-09-13 15:23:19 +02:00
parent 87b8a0b211
commit 1677f416bc
1 changed files with 1 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
doc/tutorial/describing-code.rst
View File

@@ -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::