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

Fixed typo.

Browse Source 
Should read `…an info field list…`, rather than ``…a info field list…`.
This commit is contained in:
Carlton Gibson 2022-02-23 20:29:50 +01:00 committed by GitHub
parent 586de7300a
commit 3de086fb35
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 1 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -57,7 +57,7 @@ Notice several things:
- Sphinx parsed the argument of the ``.. py:function`` directive and - Sphinx parsed the argument of the ``.. py:function`` directive and
highlighted the module, the function name, and the parameters appropriately. highlighted the module, the function name, and the parameters appropriately.
- The directive content includes a one-line description of the function, - The directive content includes a one-line description of the function,
as well as a :ref:`info field list <info-field-lists>` containing the function as well as an :ref:`info field list <info-field-lists>` containing the function
parameter, its expected type, the return value, and the return type. parameter, its expected type, the return value, and the return type.
.. note:: .. note::