From 1a22ba1452a692ff9fd0561b13239d9e59fcf7bc Mon Sep 17 00:00:00 2001 From: David Stansby Date: Mon, 7 Oct 2019 13:27:34 +0100 Subject: [PATCH] Backport PR #15379: Document formatting strings in the docs --- doc/devel/documenting_mpl.rst | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/doc/devel/documenting_mpl.rst b/doc/devel/documenting_mpl.rst index 456d449cbbb1..97dbf9ed2a16 100644 --- a/doc/devel/documenting_mpl.rst +++ b/doc/devel/documenting_mpl.rst @@ -390,7 +390,7 @@ consistent with Python's documentation: .. code-block:: rst - If *linestyles* is *None*, the 'solid' is used. + If *linestyles* is *None*, the default is 'solid'. Do not use the ```default role``` or the ````literal```` role: @@ -410,6 +410,12 @@ Use simple single or double quotes when giving string values, e.g. If 'tight', try to figure out the tight bbox of the figure. + No ``'extra'`` literal quotes. + +The use of extra literal quotes around the text is discouraged. While they +slightly improve the rendered docs, they are cumbersome to type and difficult +to read in plain-text docs. + Parameter type descriptions ~~~~~~~~~~~~~~~~~~~~~~~~~~~ The main goal for parameter type descriptions is to be readable and