8000 Doc: clarify default parameters in scatter docs by ImportanceOfBeingErnest · Pull Request #12353 · matplotlib/matplotlib · GitHub
[go: up one dir, main page]
Skip to content

Doc: clarify default parameters in scatter docs #12353

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
Oct 3, 2018
Merged

Doc: clarify default parameters in scatter docs #12353

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
14 changes: 11 additions & 3 deletions lib/matplotlib/axes/_axes.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4024,7 +4024,7 @@ def scatter(self, x, y, s=None, c=None, marker=None, cmap=None, norm=None,
The marker size in points**2.
Default is ``rcParams['lines.markersize'] ** 2``.

c : color, sequence, or sequence of color, optional, default: 'b'
c : color, sequence, or sequence of color, optional
The marker color. Possible values:

- A single color format string.
Expand All @@ -4040,10 +4040,18 @@ def scatter(self, x, y, s=None, c=None, marker=None, cmap=None, norm=None,
matching will have precedence in case of a size matching with *x*
and *y*.

marker : `~matplotlib.markers.MarkerStyle`, optional, default: 'o'
Defaults to ``None``. In that case the marker color is determined
by the value of ``color``, ``facecolor`` or ``facecolors``. In case
Copy link
Member

Choose a reason for hiding this comment

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

As a remark to the future: We use *color* instead of ``color`` for markup of arguments in the docs: https://matplotlib.org/devel/documenting_mpl.html#id4

those are not specified or ``None``, the marker color is determined
by the next color of the ``Axes``' current "shape and fill" color
cycle. This cycle defaults to :rc:`axes.prop_cycle`.

marker : `~matplotlib.markers.MarkerStyle`, optional
The marker style. *marker* can be either an instance of the class
or the text shorthand for a particular marker.
See `~matplotlib.markers` for more information marker styles.
Defaults to ``None``, in which case it takes the value of
:rc:`scatter.marker` = 'o'.
See `~matplotlib.markers` for more information about marker styles.

cmap : `~matplotlib.colors.Colormap`, optional, default: None
A `.Colormap` instance or registered colormap name. *cmap* is only
Expand Down
0