Skip to content

Commit 79c1c56

Browse files
committed
Document formatting strings in the docs
1 parent 45b9201 commit 79c1c56

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

doc/devel/documenting_mpl.rst

+5-1
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,10 @@ 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+
The ues of extra literal quotes around the text (````'text'````) is
414+
discouraged. While they slightly improve the rendered docs, they are
415+
cumbersome to type and difficult to read in plain-text docs.
416+
413417
Parameter type descriptions
414418
~~~~~~~~~~~~~~~~~~~~~~~~~~~
415419
The main goal for parameter type descriptions is to be readable and

0 commit comments

Comments
 (0)