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

Skip to content

Commit f48ad73

Browse files
committed
DOC: fix single when double ` should have been used
1 parent b89e710 commit f48ad73

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

doc/devel/documenting_mpl.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -425,8 +425,8 @@ As opposed to the numpydoc guide, parameters need not be marked as
425425
The optional aspect is already clear from the presence of a default value.
426426
More specifically
427427

428-
- use `{name} : {type}, default: {val}` when possible.
429-
- use `{name} : {type}, optional` and describe the default in the text if
428+
- use ``{name} : {type}, default: {val}`` when possible.
429+
- use ``{name} : {type}, optional`` and describe the default in the text if
430430
in cannot be explained sufficiently in the above way.
431431

432432
Use ``float`` for a type that can be any number.

0 commit comments

Comments
 (0)