From 3de086fb3570e7b769f81400e616e6d8e6e64dc6 Mon Sep 17 00:00:00 2001 From: Carlton Gibson Date: Wed, 23 Feb 2022 20:29:50 +0100 Subject: [PATCH] Fixed typo. MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Should read `…an info field list…`, rather than ``…a info field list…`. --- doc/tutorial/describing-code.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) 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 ` containing the function + as well as an :ref:`info field list ` containing the function parameter, its expected type, the return value, and the return type. .. note::