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

Remove square brackets

Browse Source
This commit is contained in:
Juan Luis Cano Rodríguez
2021-09-13 15:17:14 +02:00
parent c2847c2563
commit 87b8a0b211
3 changed files with 2 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

BIN
doc/_static/tutorial/lumache-py-function-full.png vendored
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 70 KiB

After

Width:  |  Height:  |  Size: 70 KiB

BIN
doc/_static/tutorial/lumache-py-function.png vendored
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 40 KiB

After

Width:  |  Height:  |  Size: 41 KiB

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

@@ -24,7 +24,7 @@ as follows:
To retrieve a list of random ingredients,
you can use the ``lumache.get_random_ingredients()`` function:
.. py:function:: lumache.get_random_ingredients([kind=None])
.. py:function:: lumache.get_random_ingredients(kind=None)
Return a list of random ingredients as strings.
@@ -46,8 +46,6 @@ 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 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.
@@ -94,7 +92,7 @@ Then, add this exception to the original description of the function:
:caption: docs/source/usage.rst
:emphasize-lines: 7
.. py:function:: lumache.get_random_ingredients([kind=None])
.. py:function:: lumache.get_random_ingredients(kind=None)
Return a list of random ingredients as strings.