From 82677dd9669d41df89be89dbef931b8e2c2ce80c Mon Sep 17 00:00:00 2001
From: jposada202020 <jquintana202020@gmail.com>
Date: Sat, 15 May 2021 12:06:08 -0400
Subject: [PATCH] adding parameter documentation explanation.

---
 docs/design_guide.rst | 26 ++++++++++++++++++++++++++
 1 file changed, 26 insertions(+)

diff --git a/docs/design_guide.rst b/docs/design_guide.rst
index 0c3beb8550..8c3c8cc842 100644
--- a/docs/design_guide.rst
+++ b/docs/design_guide.rst
@@ -332,6 +332,32 @@ To add different types outside CircuitPython you need to include them in the int
 The intersphinx_mapping above includes references to Python, BusDevice and CircuitPython
 Documentation
 
+When the parameter have two different types, you should reference them as follows::
+
+
+    class Character_LCD:
+        """Base class for character LCD
+
+           :param ~digitalio.DigitalInOut rs: The reset data line
+           :param ~pwmio.PWMOut,~digitalio.DigitalInOut blue: Blue RGB Anode
+
+        """
+
+        def __init__(self, rs, blue):
+            self._rc = rs
+            self.blue = blue
+
+
+Renders as:
+
+.. py:class:: Character_LCD(rs, blue)
+    :noindex:
+
+    Base class for character LCD
+
+    :param ~digitalio.DigitalInOut rs: The reset data line
+    :param ~pwmio.PWMOut,~digitalio.DigitalInOut blue: Blue RGB Anode
+
 
 param_name
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~