From 3c49bd6bde1525558def647d0cca3d99ec9fb708 Mon Sep 17 00:00:00 2001 From: jposada202020 <34255413+jposada202020@users.noreply.github.com> Date: Wed, 28 Apr 2021 13:15:09 -0400 Subject: [PATCH] Update docs/design_guide.rst Co-authored-by: Kattni --- docs/design_guide.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/design_guide.rst b/docs/design_guide.rst index 4c9ca00521..814962c7c7 100644 --- a/docs/design_guide.rst +++ b/docs/design_guide.rst @@ -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: