Skip to content

Commit 0f60a3b

Browse files
committed
Better_phrasing
1 parent 0fa6f4e commit 0f60a3b

File tree

1 file changed

+5
-6
lines changed

1 file changed

+5
-6
lines changed

docs/design_guide.rst

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -529,15 +529,14 @@ SPI Example
529529
530530
531531
532-
Class example template
532+
Class documentation example template
533533
--------------------------------------------------------------------------------
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
536536
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.
538538

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:
541540

542541

543542
.. code-block:: python

0 commit comments

Comments
 (0)