djsundog/circuitpython
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update docs/design_guide.rst

Browse Source 
Co-authored-by: Kattni <kattni@adafruit.com>
This commit is contained in:
jposada202020 2021-04-28 13:15:17 -04:00 committed by GitHub
parent 3c49bd6bde
commit 69a510edc1
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/design_guide.rst
View File

@ -308,8 +308,8 @@ following structure:
param_type
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Type of the parameter. This could be among other `int`, `float`, `str` `bool`, etc.
When referring to different objects in the CircuitPython domain you need to include the reference
by adding a ``~`` before the definition as shown in the following example:
To document an object in the CircuitPython domain, you need to include a ``~`` before the
definition as shown in the following example:
.. code-block:: sh