From 0f60a3b997b26b5d0a67d547247867d0b63bb2f0 Mon Sep 17 00:00:00 2001 From: jposada202020 Date: Wed, 5 May 2021 12:18:26 -0400 Subject: [PATCH] Better_phrasing --- docs/design_guide.rst | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) diff --git a/docs/design_guide.rst b/docs/design_guide.rst index cc6288ccd9..e91060f776 100644 --- a/docs/design_guide.rst +++ b/docs/design_guide.rst @@ -529,15 +529,14 @@ SPI Example -Class example template +Class documentation example template -------------------------------------------------------------------------------- -When documenting classes, you could use the following template to illustrate the basic class functioning. -it is closely related with the simpletest, however this will display the information in the readthedocs +When documenting classes, you should use the following template to illustrate basic usage. +It is similar with the simpletest example, however this will display the information in the Read The Docs documentation. -The advantage of using this, is users will be familiar with this as it is used across libraries +The advantage of using this template is it makes the documentation consistent across the libraries. -This is an example for a AHT20 temperature sensor. You could locate this after the class parameter -definitions. +This is an example for a AHT20 temperature sensor. Include the following after the class parameter: .. code-block:: python