Skip to content

Commit 69a510e

Browse files
Update docs/design_guide.rst
Co-authored-by: Kattni <[email protected]>
1 parent 3c49bd6 commit 69a510e

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
@@ -308,8 +308,8 @@ following structure:
308308
param_type
309309
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
310310
Type of the parameter. This could be among other `int`, `float`, `str` `bool`, etc.
311-
When referring to different objects in the CircuitPython domain you need to include the reference
312-
by adding a ``~`` before the definition as shown in the following example:
311+
To document an object in the CircuitPython domain, you need to include a ``~`` before the
312+
definition as shown in the following example:
313313

314314
.. code-block:: sh
315315

0 commit comments

Comments
 (0)