Commit79c1c56

committed

Document formatting strings in the docs

1 parent45b9201 commit79c1c56Copy full SHA for 79c1c56

File tree

-1

lines changed

-1

lines changed

Lines changed: 5 additions & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -390,7 +390,7 @@ consistent with Python's documentation:`
`390`	`390`
`391`	`391`	`..code-block::rst`
`392`	`392`
`393`		`- If linestyles is None, the'solid' isused.`
	`393`	`+ If linestyles is None, thedefault is'solid'.`
`394`	`394`
`395`	`395`	Do not use the ```default role``` or the ````literal```` role:
`396`	`396`
`@@ -410,6 +410,10 @@ Use simple single or double quotes when giving string values, e.g.`
`410`	`410`
`411`	`411`	`If 'tight', try to figure out the tight bbox of the figure.`
`412`	`412`
	`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`	`+`
`413`	`417`	`Parameter type descriptions`
`414`	`418`	`~~~~~~~~~~~~~~~~~~~~~~~~~~~`
`415`	`419`	`The main goal for parameter type descriptions is to be readable and`

Comments

(0)