X Tutup
Skip to content

DOC better docstring for hist2d #8429

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

Closed
NelleV wants to merge 1 commit into from
Closed

DOC better docstring for hist2d #8429

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
16 changes: 15 additions & 1 deletion lib/matplotlib/axes/_axes.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6457,7 +6457,21 @@ def hist2d(self, x, y, bins=10, range=None, normed=False, weights=None,

Other parameters
----------------
kwargs : :meth:`pcolorfast` properties.
cmap : [None, Colormap, string], optional
Copy link
Copy Markdown
Member

@dstansby dstansby Apr 5, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would it be okay to get rid of the square brackets? I don't think they're anywhere else (or at least haven't been in recent doc PRs)

Copy link
Copy Markdown
Member

@phobson phobson Apr 5, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@dstansby see section 4: https://github.com/numpy/numpy/blob/master/doc/HOWTO_DOCUMENT.rst.txt

if anything, they should be {}'s

A :class:`matplotlib.colors.Colormap` instance from cm. If None,
use rc settings.

norm : [None | Normalize]
A :class:`matplotlib.colors.Normalize` instance is used to scale
luminance data to 0,1. If None, defaults to normalize()

vmin/vmax : [None | scalar]
vmin and vmax are used in conjunction with norm to normalize
Copy link
Copy Markdown
Member

@dstansby dstansby Apr 5, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

vmin and vmax (they're keyword arguments)

luminance data.

alpha : ``0 <= scalar <= 1`` or *None*
the alpha blending value
Copy link
Copy Markdown
Member

@dstansby dstansby Apr 5, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Capitalise 'the'



See also
--------
Expand Down
X Tutup