Skip to content

Commit 9c12b18

Browse files
committed
title change
1 parent 71d575f commit 9c12b18

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

docs/design_guide.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -293,7 +293,7 @@ Renders as:
293293
:param int address: The I2C address of the device. Defaults to :const:`0x40`
294294

295295

296-
Parameters Documentation
296+
Documenting Parameters
297297
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
298298
Although there are different ways to document class and functions definitions in Python,
299299
the following is the prevalent method of documenting parameters
@@ -308,7 +308,7 @@ following structure:
308308
param_type
309309
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
310310
The type of the parameter. This could be among other `int`, `float`, `str` `bool`, etc.
311-
To document an object in the CircuitPython domain, you need to include a ``~`` before the
311+
To document an object in the CircuitPython domain, you need to include a ``~`` before the
312312
definition as shown in the following example:
313313

314314
.. code-block:: sh

0 commit comments

Comments
 (0)