Skip to content

adding parameter documentation explanation when it could have two differents types #4767

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 18, 2021
Merged

adding parameter documentation explanation when it could have two differents types #4767

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 26 additions & 0 deletions docs/design_guide.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Expand Down