diff options
| author | Carlton Gibson <carlton@noumenal.es> | 2022-02-23 20:29:50 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-02-23 20:29:50 +0100 |
| commit | 3de086fb3570e7b769f81400e616e6d8e6e64dc6 (patch) | |
| tree | dd9ae0374870119fc3066f3199e40c0176a5752d /doc/tutorial | |
| parent | 586de7300a5269de93b4d813408ffdbf10ce2409 (diff) | |
| download | sphinx-git-3de086fb3570e7b769f81400e616e6d8e6e64dc6.tar.gz | |
Fixed typo.
Should read `…an info field list…`, rather than ``…a info field list…`.
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 0b88f5bd9..57f1b2008 100644 --- a/doc/tutorial/describing-code.rst +++ b/doc/tutorial/describing-code.rst @@ -57,7 +57,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:`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. .. note:: |