djsundog/circuitpython
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

adding_backticks, typos

Browse Source
This commit is contained in:
jposada202020 2021-04-28 06:07:45 -04:00
parent 0c23c73510
commit 4e931697c6
1 changed files with 10 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
docs/design_guide.rst
View File

@ -296,24 +296,28 @@ 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 paramaters documenations
the following is the prevalent method of doing parameters documentations
for CircuitPython libraries. When documenting class parameters you should use the
following structure::
following structure:
:param ~busio.I2C i2c_bus: The I2C bus the DS3231 is connected to
.. code-block:: sh
:param param_type param_name: Parameter_description
param_type
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Type of the parameter. This could be amon other ``int``, ``float``, ``str`` ``bool``, etc.
Type of the parameter. This could be among other `int`, `float`, `str` `bool`, etc.
When referring to different objects in the CircuitPython domain you need to include the reference
by adding a `~` before the definition as shown in the following example::
by adding a ``~`` before the definition as shown in the following example:
.. code-block:: sh
:param ~busio.I2C i2c_bus: The I2C bus the DS3231 is connected to.
To include references to CircuitPython modules cookiecutter creates an entry in the
intersphinx_mapping entry in the `conf.py` file located within the `docs` directory.
intersphinx_mapping entry in the ``conf.py`` file located within the ``docs`` directory.
To add different types outside CircuitPython you need to add more definition to intersphinx_mapping::