From 176aa681f091230fbd2eb4862a8faa5586e8febf Mon Sep 17 00:00:00 2001 From: Paul Sokolovsky Date: Sun, 25 Jun 2017 00:26:44 +0300 Subject: [PATCH] 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. --- CODECONVENTIONS.md | 14 ++++++++++---- 1 file 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 `. :ref:`xref_target`). ~~~ +* Linking to external URL: +``` +`link text `_ +``` + +* 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 `. Description common to foo() and bar(). ~~~ -* Linking to external URL: -``` -`link text `_ -``` More detailed guides and quickrefs: