Browse Source

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.
pull/3017/merge
Paul Sokolovsky 7 years ago
parent
commit
176aa681f0
  1. 14
      CODECONVENTIONS.md

14
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:

Loading…
Cancel
Save