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:09 -04:00 committed by GitHub
parent 4e931697c6
commit 3c49bd6bde
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 1 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/design_guide.rst
View File

@ -296,7 +296,7 @@ Renders as:
Parameters Documentation
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Although there are different ways to document class and functions definitions in Python,
the following is the prevalent method of doing parameters documentations
the following is the prevalent method of documenting parameters
for CircuitPython libraries. When documenting class parameters you should use the
following structure: