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

CODECONVENTIONS: docs: Markup for None/True/False.

Browse Source 
Based on what CPython uses. However, Read The Docs theme styles this
markup in very stand-out way, so we may think what to do about it.
This commit is contained in:
Paul Sokolovsky 2017-06-25 00:26:44 +03:00
parent 7f2bc83dbc
commit 176aa681f0
1 changed files with 10 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
CODECONVENTIONS.md
View File

@ -184,6 +184,16 @@ This is :ref:`reference <xref_target>`.
:ref:`xref_target`). :ref:`xref_target`).
~~~ ~~~
* Linking to external URL:
```
`link text <http://foo.com/...>`_
```
* Referencing builtin singleton objects:
```
``None``, ``True``, ``False``
```
* Use following syntax to create common description for more than one element: * Use following syntax to create common description for more than one element:
~~~ ~~~
.. function:: foo(x) .. function:: foo(x)
@ -192,10 +202,6 @@ This is :ref:`reference <xref_target>`.
Description common to foo() and bar(). Description common to foo() and bar().
~~~ ~~~
* Linking to external URL:
```
`link text <http://foo.com/...>`_
```
More detailed guides and quickrefs: More detailed guides and quickrefs: