Thanks to visit codestin.com
Credit goes to github.com

Skip to content

numpydoc ListedColormap parameters #13780

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
Apr 1, 2019
Merged

numpydoc ListedColormap parameters #13780

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7d5b8f7
numpydoc ListedColormap parameters
dstansby Mar 28, 2019
c540411
Apply suggestions from code review
dstansby Mar 29, 2019
36253c0
Fix long line
dstansby Apr 1, 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
39 changes: 19 additions & 20 deletions lib/matplotlib/colors.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -745,35 +745,34 @@ def func_r(x):


class ListedColormap(Colormap):
"""Colormap object generated from a list of colors.
"""
Colormap object generated from a list of colors.

This may be most useful when indexing directly into a colormap,
but it can also be used to generate special colormaps for ordinary
mapping.
"""
def __init__(self, colors, name='from_list', N=None):
"""
Make a colormap from a list of colors.

*colors*
a list of matplotlib color specifications,
or an equivalent Nx3 or Nx4 floating point array
(*N* rgb or rgba values)
*name*
a string to identify the colormap
*N*
the number of entries in the map. The default is *None*,
in which case there is one colormap entry for each
element in the list of colors. If::
Parameters
----------
colors : list, array
List of Matplotlib color specifications, or an equivalent Nx3 or Nx4
floating point array (*N* rgb or rgba values).
name : str, optional
String to identify the colormap.
N : int, optional
Number of entries in the map. The default is *None*, in which case
there is one colormap entry for each element in the list of colors.
If::

N < len(colors)
N < len(colors)

the list will be truncated at *N*. If::
the list will be truncated at *N*. If::

N > len(colors)
N > len(colors)

the list will be extended by repetition.
"""
the list will be extended by repetition.
"""
def __init__(self, colors, name='from_list', N=None):
self.monochrome = False # True only if all colors in map are
# identical; needed for contouring.
if N is None:
Expand Down