Skip to content

Update writing docs concerning explicit parameter lists #10280

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jan 22, 2018
Merged

Update writing docs concerning explicit parameter lists #10280

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 11 additions & 4 deletions doc/devel/documenting_mpl.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -337,7 +337,7 @@ An example docstring looks like:

colors : array_like of colors, optional, default: 'k'

linestyles : ['solid' | 'dashed' | 'dashdot' | 'dotted'], optional
linestyles : {'solid', 'dashed', 'dashdot', 'dotted'}, optional

label : string, optional, default: ''

Expand Down Expand Up @@ -389,10 +389,9 @@ to keep in mind:
Parameters
----------
projection :
['aitoff' | 'hammer' | 'lambert' | 'mollweide' | \
'polar' | 'rectilinear'], optional
{'aitoff', 'hammer', 'lambert', 'mollweide', 'polar', \
'rectilinear'}, optional
The projection type of the axes.
"""

...
"""
Expand All @@ -411,6 +410,14 @@ to keep in mind:
-------
lines : `~matplotlib.collections.LineCollection`


Deprecated formatting conventions
---------------------------------
* Formerly, we have used square brackets for explicit parameter lists
``['solid' | 'dashed' | 'dotted']``. With numpydoc we have switched to their
standard using curly braces ``{'solid', 'dashed', 'dotted'}``.


Linking to other code
---------------------
To link to other methods, classes, or modules in Matplotlib you can encase
Expand Down