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

Rephrase explanation on square brackets

Browse Source
This commit is contained in:
Juan Luis Cano Rodríguez
2021-09-06 14:58:18 +02:00
parent c721d1746a
commit 722629b35b
1 changed files with 2 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -47,8 +47,8 @@ Notice several things:
- Sphinx parsed the argument of the ``.. py:function`` directive and
highlighted the module, the function name, and the parameters appropriately.
- Putting a parameter inside square brackets usually conveys that it is
optional (although it is not mandatory to use this syntax).
- Putting a parameter inside square brackets is a convention that conveys it is
optional. This syntax is not mandatory but can be useful for readers.
- The directive content includes a one-line description of the function,
as well as a :ref:`field list <rst-field-lists>` containing the function
parameter, its expected type, the return value, and the return type.