Refresh what's new page for 3.3.0 by QuLogic · Pull Request #17858 · matplotlib/matplotlib

QuLogic · 2020-07-08T20:49:32Z

PR Summary

This fixes some minor things (see commit messages), but major thing is the re-ordering.

Generally, this is things-with-a-plot, then things-with-an-example, then some random other stuff, and finally groups of things-with-something-in-common (e.g., all rcParams together).

Now, I'll be adding in plots, but this is maybe large enough to review already.

PR Checklist

[N/A] Has Pytest style unit tests
Code is Flake 8 compliant
New features are documented, with examples if plot related
Documentation is sphinx and numpydoc compliant
Added an entry to doc/users/next_whats_new/ if major new feature (follow instructions in README.rst there)
[N/A] Documented in doc/api/next_api_changes/* if API changed in a backward-incompatible way

This totally messed up the page ToC.

Generally, this is things-with-a-plot, then things-with-an-example, then some random other stuff, and finally groups of things-with-something-in-common (e.g., all rcParams together).

This prevents overflow of the ToC in the sidebar.

QuLogic · 2020-07-09T22:19:29Z

Added more plots, added more entries (like turbo, pie normalize, etc.). You may wish to review the commits separately.

story645

For all my nitpicks, I really do 😍 this what's new.
Big picture, can you group all the RCParam stuff under a subheading, and same /w all the font/text stuff. Maybe also the ticks & labels stuff (the titling, coloring. formatting, etc). the semantic and sharing stuff is all axes creation/management.

doc/users/prev_whats_new/whats_new_3.3.0.rst

story645 · 2020-07-10T03:28:24Z

doc/users/prev_whats_new/whats_new_3.3.0.rst

-``canvas.mpl_connect("button_press_event", button_press_handler)``, rather than
-having to write wrapper functions that fill in the (now optional) *canvas* and
-*toolbar* parameters.
+Instead, they are implemented using vanilla JavaScript. Please report any


plain Javascript

Vanilla JS is a 'thing'.

yes, that's why I was kinda confused about this terminology here, didn't grok til just now that that's a joke page.

QuLogic · 2020-07-10T06:20:43Z

rcParams are already in a subheading; it's just such a low level that our styling doesn't make it super obvious.

QuLogic · 2020-07-10T07:14:00Z

I made some edits except for the things I don't know about noted above. I haven't done any of the requested re-ordering yet. Do you mean group as in move together, or add more headings?

story645 · 2020-07-10T16:57:58Z

Both - group like things together under a subheading, like paths and 3d already have.

QuLogic · 2020-07-10T21:36:47Z

My new order is now:

Figure and Axes creation / management
- Provisional API for composing semantic axes layouts from text or nested lists
- GridSpec.subplots()
- New Axes.sharex, Axes.sharey methods
- tight_layout now supports suptitle
- Setting axes box aspect
Colors and colormaps
- Turbo colormap
- colors.BoundaryNorm supports extend keyword argument
- Text color for legend labels
- Pcolor and Pcolormesh now accept shading='nearest' and 'auto'
Titles, ticks, and labels
- Align labels to Axes edges
- Allow tick formatters to be set with str or function inputs
- Axes.set_title gains a y keyword argument to control auto positioning
- Offset text is now set to the top when using axis.tick_top()
Fonts
- Simple syntax to select fonts by absolute path
- Improved font weight detection

followed by these, which have not changed, so I'm not going to copy&paste all the subheadings:

rcParams improvements
3D Axes improvements
Interactive tool improvements
Functions to compute a Path's size
Backend-specific improvements

So now I'm wondering where to put:

New Axes.axline method
Dates use a modern epoch
Lines now accept MarkerStyle instances as input
imshow now coerces 3D arrays with depth 1 to 2D
~~Set zorder of contour labels~~ This can go in: Titles, ticks and labels
Better control of Axes.pie normalization

jklymak · 2020-07-11T21:20:05Z

So now I'm wondering where to put:

I think its OK to have a "other changes" section...

story645

Agree w/ @jklymak & also most of the rest of these have to do w/ plot types:

New Axes.axline method
imshow now coerces 3D arrays with depth 1 to 2D
Better control of Axes.pie normalization

And d

Dates use a modern epoch
Lines now accept MarkerStyle instances as input

doc/users/prev_whats_new/whats_new_3.3.0.rst

story645 · 2020-07-12T15:19:00Z

doc/users/prev_whats_new/whats_new_3.3.0.rst

+    # For the purposes of keeping the documentation build warning-free, and
+    # future proof for when the deprecation is made permanent, we pass
+    # *normalize* here explicitly anyway.
+    ax[1, 0].pie(x, autopct='%1.2f%%', labels=label(x), normalize=False)
+    ax[1, 0].set_title('normalize unspecified\nsum(x) < 1')
+    ax[1, 1].pie(x * 10, autopct='%1.2f%%', labels=label(x * 10),
+                 normalize=True)
+    ax[1, 1].set_title('normalize unspecified\nsum(x) > 1')
+


why does this need to be in the what's new?

What part specifically?

the code and especially this note:

For the purposes of keeping the documentation build warning-free, and
# future proof for when the deprecation is made permanent, we pass
# normalize here explicitly anyway.

Sorry, I'm confused; didn't you ask for code?

😦 sorry for the confusion, I did ask for code and the note threw me 'cause I read it as explaining a deprecated feature rather than a new one. Maybe movinng the comment under the code could make it clearer?

Oh, well this is showing deprecated behaviour as comparison with the new explicit one, but because it's deprecated, I had to use the new explicit one in the code. It's labelled with the old way in the figure though. (Note, this code isn't shown by default.) I could remove it or change the comment description a little?

Oh, if the code/comment isn't shown than it's good enough...

QuLogic · 2020-07-14T06:49:38Z

I pushed the re-ordering and used the following sections for the remaining items:

Plot-type specific changes
- New Axes.axline method
- imshow now coerces 3D arrays with depth 1 to 2D
- Better control of Axes.pie normalization
Other changes
- Dates use a modern epoch
- Lines now accept MarkerStyle instances as input

I'm not super-happy with that first section name, so suggestions welcome.

story645

Thanks for putting up w/ my comments - it's now coherent enough to make me happy.

doc/users/prev_whats_new/whats_new_3.3.0.rst

story645 · 2020-07-15T16:04:04Z

@tacaswell said it's docs and therefore can go in w/ one merge (or even a self merge 🤷

…858-on-v3.3.x Backport PR #17858 on branch v3.3.x (Refresh what's new page for 3.3.0)

QuLogic added 5 commits July 7, 2020 22:29

DOC: Fix names for GitHub stats pages.

b562b91

Add some duplicate names to mailmap.

1472b39

DOC: Fix some inconsistent heading underlines.

d5eace4

DOC: Don't use cross-references in section titles.

8d82673

This totally messed up the page ToC.

DOC: Re-order 3.3. what's new page.

20ccea8

Generally, this is things-with-a-plot, then things-with-an-example, then some random other stuff, and finally groups of things-with-something-in-common (e.g., all rcParams together).

QuLogic added the Documentation label Jul 8, 2020

QuLogic added this to the v3.3.0 milestone Jul 8, 2020

QuLogic mentioned this pull request Jul 8, 2020

Plot directive may be confused by ..include:: #17860

Closed

QuLogic added 3 commits July 8, 2020 19:15

DOC: Shorten a title.

1768605

This prevents overflow of the ToC in the sidebar.

DOC: Add more plots to 3.3 what's new.

fd7eb1d

DOC: Add more entries to 3.3 what's new.

9471870

QuLogic marked this pull request as ready for review July 9, 2020 22:18

story645 requested changes Jul 10, 2020

View reviewed changes

DOC: Fix a typo in Axes.pie docstring.

a43d8b3

QuLogic force-pushed the doc-330 branch from f0f7421 to eaaf4a8 Compare July 10, 2020 07:13

story645 requested changes Jul 12, 2020

View reviewed changes

QuLogic added 2 commits July 14, 2020 01:06

DOC: Edit the 3.3 what's new based on review.

e6648a7

DOC: More edits to the 3.3 what's new from review.

2fb42b1

QuLogic force-pushed the doc-330 branch from eaaf4a8 to 2fb42b1 Compare July 14, 2020 06:16

story645 approved these changes Jul 14, 2020

View reviewed changes

doc/users/prev_whats_new/whats_new_3.3.0.rst Outdated Show resolved Hide resolved

DOC: Re-order 3.3 what's new changes.

42ce0c7

QuLogic force-pushed the doc-330 branch from 70d301f to 42ce0c7 Compare July 15, 2020 02:13

story645 merged commit b560513 into matplotlib:master Jul 15, 2020

meeseeksmachine mentioned this pull request Jul 15, 2020

Backport PR #17858 on branch v3.3.x (Refresh what's new page for 3.3.0) #17933

Merged

meeseeksmachine pushed a commit to meeseeksmachine/matplotlib that referenced this pull request Jul 15, 2020

Backport PR matplotlib#17858: Refresh what's new page for 3.3.0

9109275

tacaswell added a commit that referenced this pull request Jul 15, 2020

Merge pull request #17933 from meeseeksmachine/auto-backport-of-pr-17…

c1c9bc8

…858-on-v3.3.x Backport PR #17858 on branch v3.3.x (Refresh what's new page for 3.3.0)

QuLogic deleted the doc-330 branch July 15, 2020 18:56

Uh oh!

Conversation

QuLogic commented Jul 8, 2020

PR Summary

PR Checklist

Uh oh!

QuLogic commented Jul 9, 2020

Uh oh!

story645 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

QuLogic commented Jul 10, 2020

Uh oh!

QuLogic commented Jul 10, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

story645 commented Jul 10, 2020

Uh oh!

QuLogic commented Jul 10, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

jklymak commented Jul 11, 2020

Uh oh!

story645 left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

story645 Jul 13, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

story645 Jul 14, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

QuLogic commented Jul 14, 2020

Uh oh!

story645 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

story645 commented Jul 15, 2020

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

QuLogic commented Jul 10, 2020 •

edited

Loading

QuLogic commented Jul 10, 2020 •

edited

Loading

story645 left a comment •

edited

Loading

story645 Jul 13, 2020 •

edited

Loading

story645 Jul 14, 2020 •

edited

Loading