Merge pull request #4767 from jposada202020/parameter_union_doc_example
adding parameter documentation explanation when it could have two differents types
This commit is contained in:
commit
c2ebe555f3
@ -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
|
The intersphinx_mapping above includes references to Python, BusDevice and CircuitPython
|
||||||
Documentation
|
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
|
param_name
|
||||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
Loading…
Reference in New Issue
Block a user