Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 1a22ba1

Browse files
dstansbyMeeseeksDev[bot]
authored and
MeeseeksDev[bot]
committed
Backport PR #15379: Document formatting strings in the docs
1 parent 50824ba commit 1a22ba1

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

doc/devel/documenting_mpl.rst

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -390,7 +390,7 @@ consistent with Python's documentation:
390390

391391
.. code-block:: rst
392392
393-
If *linestyles* is *None*, the 'solid' is used.
393+
If *linestyles* is *None*, the default is 'solid'.
394394
395395
Do not use the ```default role``` or the ````literal```` role:
396396

@@ -410,6 +410,12 @@ Use simple single or double quotes when giving string values, e.g.
410410
411411
If 'tight', try to figure out the tight bbox of the figure.
412412
413+
No ``'extra'`` literal quotes.
414+
415+
The use of extra literal quotes around the text is discouraged. While they
416+
slightly improve the rendered docs, they are cumbersome to type and difficult
417+
to read in plain-text docs.
418+
413419
Parameter type descriptions
414420
~~~~~~~~~~~~~~~~~~~~~~~~~~~
415421
The main goal for parameter type descriptions is to be readable and

0 commit comments

Comments
 (0)