diff options
| author | Paul Sokolovsky <pfalcon@users.sourceforge.net> | 2017-06-25 00:26:44 +0300 |
|---|---|---|
| committer | Paul Sokolovsky <pfalcon@users.sourceforge.net> | 2017-06-25 00:26:44 +0300 |
| commit | 176aa681f091230fbd2eb4862a8faa5586e8febf (patch) | |
| tree | 6f71757d56cc6571465f801cb9d3280301bc5c68 | |
| parent | 7f2bc83dbc8542e75280e2eb6a918387c459ec2f (diff) | |
| download | micropython-176aa681f091230fbd2eb4862a8faa5586e8febf.tar.gz micropython-176aa681f091230fbd2eb4862a8faa5586e8febf.zip | |
CODECONVENTIONS: docs: Markup for None/True/False.
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.
| -rw-r--r-- | CODECONVENTIONS.md | 14 |
1 files changed, 10 insertions, 4 deletions
diff --git a/CODECONVENTIONS.md b/CODECONVENTIONS.md index 860f1f88ec..f9dce71ddd 100644 --- a/CODECONVENTIONS.md +++ b/CODECONVENTIONS.md @@ -184,6 +184,16 @@ This is :ref:`reference <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: ~~~ .. function:: foo(x) @@ -192,10 +202,6 @@ This is :ref:`reference <xref_target>`. Description common to foo() and bar(). ~~~ -* Linking to external URL: -``` -`link text <http://foo.com/...>`_ -``` More detailed guides and quickrefs: |