Skip to content

DOC: more nitpick follow up #15048

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 3 commits into from
Aug 13, 2019
Merged

DOC: more nitpick follow up #15048

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b89e710
DOC: resolve a bunch of nitpick issues
tacaswell Aug 12, 2019
f48ad73
DOC: fix single ` when double `` should have been used
tacaswell Aug 12, 2019
755740e
MNT: support building the docs on windows again
tacaswell Aug 13, 2019
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
4 changes: 2 additions & 2 deletions doc/devel/documenting_mpl.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -425,8 +425,8 @@ As opposed to the numpydoc guide, parameters need not be marked as
The optional aspect is already clear from the presence of a default value.
More specifically

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

Use ``float`` for a type that can be any number.
Expand Down
Loading