Skip to content

Commit 87b8a0b

Browse files
committed
Remove square brackets
1 parent c2847c2 commit 87b8a0b

File tree

3 files changed

+2
-4
lines changed

3 files changed

+2
-4
lines changed
-279 Bytes
Loading
338 Bytes
Loading

doc/tutorial/describing-code.rst

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ as follows:
2424
To retrieve a list of random ingredients,
2525
you can use the ``lumache.get_random_ingredients()`` function:
2626
27-
.. py:function:: lumache.get_random_ingredients([kind=None])
27+
.. py:function:: lumache.get_random_ingredients(kind=None)
2828
2929
Return a list of random ingredients as strings.
3030
@@ -46,8 +46,6 @@ Notice several things:
4646

4747
- Sphinx parsed the argument of the ``.. py:function`` directive and
4848
highlighted the module, the function name, and the parameters appropriately.
49-
- Putting a parameter inside square brackets is a convention that conveys it is
50-
optional. This syntax is not mandatory but can be useful for readers.
5149
- The directive content includes a one-line description of the function,
5250
as well as a :ref:`field list <rst-field-lists>` containing the function
5351
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:
9492
:caption: docs/source/usage.rst
9593
:emphasize-lines: 7
9694
97-
.. py:function:: lumache.get_random_ingredients([kind=None])
95+
.. py:function:: lumache.get_random_ingredients(kind=None)
9896
9997
Return a list of random ingredients as strings.
10098

0 commit comments

Comments
 (0)