File tree Expand file tree Collapse file tree 1 file changed +5
-6
lines changed Expand file tree Collapse file tree 1 file changed +5
-6
lines changed Original file line number Diff line number Diff line change @@ -529,15 +529,14 @@ SPI Example
529
529
530
530
531
531
532
- Class example template
532
+ Class documentation example template
533
533
--------------------------------------------------------------------------------
534
- When documenting classes, you could use the following template to illustrate the basic class functioning .
535
- it is closely related with the simpletest, however this will display the information in the readthedocs
534
+ When documenting classes, you should use the following template to illustrate basic usage .
535
+ It is similar with the simpletest example , however this will display the information in the Read The Docs
536
536
documentation.
537
- The advantage of using this, is users will be familiar with this as it is used across libraries
537
+ The advantage of using this template is it makes the documentation consistent across the libraries.
538
538
539
- This is an example for a AHT20 temperature sensor. You could locate this after the class parameter
540
- definitions.
539
+ This is an example for a AHT20 temperature sensor. Include the following after the class parameter:
541
540
542
541
543
542
.. code-block :: python
You can’t perform that action at this time.
0 commit comments