8000 DOC updated hexbin documentation to numpydoc format. by dcmarcu · Pull Request #7170 · matplotlib/matplotlib · GitHub
[go: up one dir, main page]
Skip to content

DOC updated hexbin documentation to numpydoc format. #7170

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 6 commits into from
Sep 28, 2016
Merged

DOC updated hexbin documentation to numpydoc format. #7170

Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
e93286d
DOC updated hexbin documentation to numpydoc format.
dcmarcu Sep 23, 2016
dfa9f6f
DOC fixed pep8 compliance, added parameter defaults, fixed parsing is…
dcmarcu Sep 25, 2016
22acb50
DOC fixed pep8 conformance issue on line 4183 (line too long), made i…
dcmarcu Sep 25, 2016
d0aa9ae
DOC Reduced repetitions, made corrections on linewidths and edgecolors
dcmarcu Sep 26, 2016
d43caec
Fixed line 4173 for pep8 conformance
dcmarcu Sep 26, 2016
465f7b2
DOC Updated gridsize description, language consistency where multiple…
dcmarcu Sep 27, 2016
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
Prev Previous commit
Next Next commit
DOC Reduced repetitions, made corrections on linewidths and edgecolors
  • Loading branch information
@dcmarcu
dcmarcu committed Sep 26, 2016
commit d0aa9ae08676d04192b7f5d067fb9da46a8f67d6
39 changes: 10 additions & 29 deletions lib/matplotlib/axes/_axes.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4097,17 +4097,9 @@ def hexbin(self, x, y, C=None, gridsize=100, bins=None,

Parameters
----------
x : array
may be masked array, in which case only unmasked points
will be plotted

y : array
may be masked array, in which case only unmasked points
will be plotted
x, y : array, masked array

C : array, default is *None*
may be masked array, in which case only unmasked points
will be plotted
C : array, masked array, optional, default is *None*

gridsize : int, optional, default is 100
Copy link
Member

Choose a reason for hiding this comment

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

This should say something like "int, (int, int), optional, default is 100".

The number of hexagons in the *x*-direction, default is
Expand Down Expand Up @@ -4167,37 +4159,26 @@ def hexbin(self, x, y, C=None, gridsize=100, bins=None,
:class:`matplotlib.colors.Normalize` instance is used to
scale luminance data to 0,1.

vmin : scalar, optional, default is *None*
*vmin* is used in conjunction with *norm* to normalize
luminance data. If *None*, the min of the color array *C*
is used. Note if you pass a norm instance, your settings
for *vmin* will be ignored.

vmax : scalar, optional, default is *None*
*vmax* is used in conjunction with *norm* to normalize
luminance data. If *None*, the max of the color array *C*
is used. Note if you pass a norm instance, your settings
for *vmax* will be ignored.
vmin, vmax : scalar, optional, default is *None*
*vmin* and *vmax* are used in conjunction with *norm* to
normalize luminance data. If *None*, the min and max of the
color array *C* are used. Note if you pass a norm instance
your settings for *vmin* and *vmax* will be ignored.

alpha : scalar between 0 and 1, optional, default is *None*
the alpha value for the patches

linewidths : scalar, optional, default is *None*
If *None*, defaults to 1.0. Note that this is a tuple, and
if you set the linewidths argument you must set it as a
sequence of floats, as required by
:class:`~matplotlib.collections.RegularPolyCollection`.
If *None*, defaults to 1.0.

edgecolors : {'none'}, mpl color, color sequence, optional,
default is 'none'
edgecolors : {'none'}, mpl color, optional, default is 'none'
If 'none', draws the edges in the same color as the fill color.
This is the default, as it avoids unsightly unpainted pixels
between the hexagons.

If *None*, draws the outlines in the default color.

If a matplotlib color arg or sequence of rgba tuples, draws the
outlines in the specified color.
If a matplotlib color arg, draws the outlines in the specified color.

Returns
-------
Expand Down
0