Skip to content

DOC: missing API docs from #8032 #8285

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
merged 3 commits into from
Mar 18, 2017

Conversation

tacaswell
Copy link
Member

@tacaswell tacaswell commented Mar 13, 2017

missing API docs from #8032

@tacaswell tacaswell added this to the 2.0.1 (next bug fix release) milestone Mar 13, 2017
@tacaswell tacaswell added Documentation Release critical For bugs that make the library unusable (segfaults, incorrect plots, etc) and major regressions. labels Mar 13, 2017
Copy link
Contributor

@afvincent afvincent left a comment

Choose a reason for hiding this comment

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

A few comments.

Additionally, I wonder if it would be useful to precise the PR that did this? (I know some other projects do this in their changelogs but I do not know if Matplotlib does)

line width is smaller than the effective pixel size, this may result
in dashed lines turning into solid gray lines. This also required
slightly tweaking the default patterns for '--', ':', and '.-' so that
with the default line-width the final patterns would not change.
Copy link
Contributor

Choose a reason for hiding this comment

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

line-width <- line width? (to be consistent with the other utterances of the expression).

Beside, it is not totally true that the new default patterns are exactly the same as before (e.g. the dotted pattern that is not a 50 %-50 % pattern anymore). Maybe the sentence should just state that the default patterns were tweaked to remain similar with the default lw value as well as to avoid “cluttering” with line widths thiner than the previous clipping boundary.

slightly tweaking the default patterns for '--', ':', and '.-' so that
with the default line-width the final patterns would not change.

There is no way to restore the old behavior
Copy link
Contributor

Choose a reason for hiding this comment

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

Closing period?

Slightly change the algorithm to no longer clip the scaling factor,
thus the patterns will continue to shrink at thin line widths. If the
line width is smaller than the effective pixel size, this may result
in dashed lines turning into solid gray lines. This also required
Copy link
Contributor

Choose a reason for hiding this comment

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

Why gray?

Copy link
Member Author

Choose a reason for hiding this comment

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

The line was implicitly black in my head when I wrote this.

@NelleV
Copy link
Member

NelleV commented Mar 17, 2017

The same test is failing on three environments: do we have a problem on 2.0.x with the tests?
The documentation builds fine, so this PR by itself is fine.

@NelleV NelleV changed the title DOC: missing API docs from #8032 [MRG] DOC: missing API docs from #8032 Mar 17, 2017
Copy link
Member

@NelleV NelleV left a comment

Choose a reason for hiding this comment

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

I don't know if my review counts, but this looks good to me.
LGTM 👍

@NelleV NelleV changed the title [MRG] DOC: missing API docs from #8032 [MRG+1] DOC: missing API docs from #8032 Mar 17, 2017
@QuLogic QuLogic changed the title [MRG+1] DOC: missing API docs from #8032 DOC: missing API docs from #8032 Mar 18, 2017
@QuLogic QuLogic merged commit d2e813d into matplotlib:v2.0.x Mar 18, 2017
@tacaswell tacaswell deleted the doc_lw_scale_api_changes branch January 20, 2020 00:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Release critical For bugs that make the library unusable (segfaults, incorrect plots, etc) and major regressions.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants