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

Skip to content

DOC: Add missing API change docs for 1.5.3 #7254

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.

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

Conversation

tacaswell
Copy link
Member

closes #7218

@tacaswell tacaswell added this to the 2.0 (style change major release) milestone Oct 12, 2016

Prior to 1.5.3 kwargs passed to `~matplotlib.Axes.plot` were handled
in two parts -- user supplied kwargs and default kwargs generated
`~matplotlib.Axes.plot` (such as the cycled styles). The two
Copy link
Member

Choose a reason for hiding this comment

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

Seems like there's a word missing between this line and the above one.

`~matplotlib.Axes.plot` (such as the cycled styles). The two
dictionaries are now merged and passed into
`~matplotlib.lines.Line2D.__init__` all at once instead of applying the
user supplied kwargs via a bulk update after the artist has been created.
Copy link
Member

Choose a reason for hiding this comment

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

"via a bulk update" seems extraneous.


This causes ``None`` passed as ``plot(..., marker=None)`` to now 'do
the default' thing rather than to result in no marker. This is only
an issue if the user explicitly passes ``None`` and has changed the
Copy link
Member

Choose a reason for hiding this comment

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

"the user" seems like a different PoV than the rest of this document, though it's not perfectly consistent anyway...

@tacaswell tacaswell force-pushed the doc_plot_marker_kwarg_api_notes branch from 2e5b8c2 to 7f55b9e Compare October 12, 2016 01:48
@tacaswell
Copy link
Member Author

@QuLogic basicly re-wrote it.

@NelleV NelleV changed the title DOC: Add missing API change docs for 1.5.3 [MRG+1] DOC: Add missing API change docs for 1.5.3 Oct 12, 2016
in two parts -- default kwargs generated internal to
`~matplotlib.Axes.plot` (such as the cycled styles) and user supplied
kwargs. The internally generated kwargs were passed to the
`~matplotlib.lines.Line2D.__init__` and the user kwargs were passed to
Copy link
Member

@QuLogic QuLogic Oct 12, 2016

Choose a reason for hiding this comment

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

That would generate as "The internally generated kwargs were passed to the __init__ and ...", right? It seems like using the full name would be a good idea here (no ~.)

of ``ax.plot(..., marker=None)`` changed from 'no markers' to 'default markers
from rcparams'.

This is change in only evident if ``mpl.rcParams['lines.marker']`` has a value
Copy link
Member

Choose a reason for hiding this comment

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

"This is change in" -> "This change is", I think.

@NelleV NelleV merged commit b083cf6 into matplotlib:v1.5.3-doc Oct 17, 2016
@NelleV
Copy link
Member

NelleV commented Oct 17, 2016

Thanks!

@tacaswell tacaswell deleted the doc_plot_marker_kwarg_api_notes branch October 17, 2016 21:37
@QuLogic QuLogic changed the title [MRG+1] DOC: Add missing API change docs for 1.5.3 DOC: Add missing API change docs for 1.5.3 Dec 7, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants