Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Commit 7e18d8e

Browse filesBrowse files
committed
Document docstring quote convention
1 parent d4bd4e7 commit 7e18d8e
Copy full SHA for 7e18d8e

File tree

Expand file treeCollapse file tree

1 file changed

+16
-0
lines changed
Filter options
Expand file treeCollapse file tree

1 file changed

+16
-0
lines changed

‎doc/devel/documenting_mpl.rst

Copy file name to clipboardExpand all lines: doc/devel/documenting_mpl.rst
+16Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -407,6 +407,22 @@ The basic docstring conventions are covered in the `numpydoc docstring guide`_
407407
and the Sphinx_ documentation. Some Matplotlib-specific formatting conventions
408408
to keep in mind:
409409

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+
410426
Function arguments
411427
~~~~~~~~~~~~~~~~~~
412428
Function arguments and keywords within docstrings should be referred to

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.