Commit005c7a6

authored

Merge pull request#17193 from timhoffm/doc-quote

Document docstring quote convention

2 parentsee2d046 +7e18d8e commit005c7a6Copy full SHA for 005c7a6

File tree

+16

-0

lines changed

+16

-0

lines changed

Lines changed: 16 additions & 0 deletions

Original file line number	Diff line number	Diff line change
@@ -407,6 +407,22 @@ The basic docstring conventions are covered in the `numpydoc docstring guide`_
`407`	`407`	`and theSphinx_ documentation. Some Matplotlib-specific formatting conventions`
`408`	`408`	`to keep in mind:`
`409`	`409`
	`410`	`+Quote positions`
	`411`	`+~~~~~~~~~~~~~~~`
	`412`	`+The quotes for single line docstrings are on the same line (pydocstyle D200)::`
	`413`	`+`
	`414`	`+ def get_linewidth(self):`
	`415`	`+ """Return the line width in points."""`
	`416`	`+`
	`417`	`+The quotes for multi-line docstrings are on separate lines (pydocstyle D213)::`
	`418`	`+`
	`419`	`+ def set_linestyle(self, ls):`
	`420`	`+ """`
	`421`	`+ Set the linestyle of the line.`
	`422`	`+`
	`423`	`+ [...]`
	`424`	`+ """`
	`425`	`+`
`410`	`426`	`Function arguments`
`411`	`427`	`~~~~~~~~~~~~~~~~~~`
`412`	`428`	`Function arguments and keywords within docstrings should be referred to`

Comments

(0)