Doc: clarify default parameters in scatter docs #12353
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
anntzer
approved these changes
Oct 3, 2018
meeseeksmachine
pushed a commit
to meeseeksmachine/matplotlib
that referenced
this pull request
Oct 3, 2018
meeseeksmachine
pushed a commit
to meeseeksmachine/matplotlib
that referenced
this pull request
Oct 3, 2018
timhoffm
reviewed
Oct 3, 2018
| @@ -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 | |||
There was a problem hiding this comment.
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
dstansby
added a commit
that referenced
this pull request
Oct 3, 2018
…353-on-v3.0.x Backport PR #12353 on branch v3.0.x (Doc: clarify default parameters in scatter docs)
jklymak
added a commit
that referenced
this pull request
Oct 3, 2018
…353-on-v3.0.0-doc Backport PR #12353 on branch v3.0.0-doc (Doc: clarify default parameters in scatter docs)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
PR Summary
The default color of the markers in the scatterplot docstring was said to be
"b". That's wrong and led to some confusion.This PR explains the default more in detail, and also documents the default for
markercorrectly.(I couldn't test this locally, due to #12352, hence tests may fail.)
PR Checklist