Skip to content
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

Refresh what's new page for 3.3.0 #17858

Merged
merged 12 commits into from Jul 15, 2020
Merged

Refresh what's new page for 3.3.0 #17858

merged 12 commits into from Jul 15, 2020

Conversation

QuLogic
Copy link
Member

@QuLogic QuLogic commented Jul 8, 2020

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).
@QuLogic QuLogic marked this pull request as ready for review July 9, 2020 22:18
@QuLogic
Copy link
Member Author

QuLogic commented Jul 9, 2020

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

Copy link
Member

@story645 story645 left a comment

Choose a reason for hiding this comment

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

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 Outdated Show resolved Hide resolved
doc/users/prev_whats_new/whats_new_3.3.0.rst Outdated Show resolved Hide resolved
doc/users/prev_whats_new/whats_new_3.3.0.rst Outdated Show resolved Hide resolved
doc/users/prev_whats_new/whats_new_3.3.0.rst Outdated Show resolved Hide resolved
doc/users/prev_whats_new/whats_new_3.3.0.rst Outdated Show resolved Hide resolved
doc/users/prev_whats_new/whats_new_3.3.0.rst Outdated Show resolved Hide resolved
doc/users/prev_whats_new/whats_new_3.3.0.rst Outdated Show resolved Hide resolved
doc/users/prev_whats_new/whats_new_3.3.0.rst Show resolved Hide resolved
doc/users/prev_whats_new/whats_new_3.3.0.rst Outdated Show resolved Hide resolved
``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
Copy link
Member

Choose a reason for hiding this comment

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

plain Javascript

Copy link
Member Author

Choose a reason for hiding this comment

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

Vanilla JS is a 'thing'.

Copy link
Member

Choose a reason for hiding this comment

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

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
Copy link
Member Author

QuLogic commented Jul 10, 2020

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

@QuLogic
Copy link
Member Author

QuLogic commented Jul 10, 2020

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
Copy link
Member

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

@QuLogic
Copy link
Member Author

QuLogic commented Jul 10, 2020

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
Copy link
Member

jklymak commented Jul 11, 2020

So now I'm wondering where to put:

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

Copy link
Member

@story645 story645 left a comment

Choose a reason for hiding this comment

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

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 Outdated Show resolved Hide resolved
doc/users/prev_whats_new/whats_new_3.3.0.rst Show resolved Hide resolved
doc/users/prev_whats_new/whats_new_3.3.0.rst Show resolved Hide resolved
Comment on lines 453 to 491
# 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')

Copy link
Member

Choose a reason for hiding this comment

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

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

Copy link
Member Author

Choose a reason for hiding this comment

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

What part specifically?

Copy link
Member

@story645 story645 Jul 13, 2020

Choose a reason for hiding this comment

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

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.

Copy link
Member Author

Choose a reason for hiding this comment

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

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

Copy link
Member

@story645 story645 Jul 14, 2020

Choose a reason for hiding this comment

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

😦 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?

Copy link
Member Author

Choose a reason for hiding this comment

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

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?

Copy link
Member

Choose a reason for hiding this comment

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

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

@QuLogic
Copy link
Member Author

QuLogic commented Jul 14, 2020

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.

Copy link
Member

@story645 story645 left a comment

Choose a reason for hiding this comment

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

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 Outdated Show resolved Hide resolved
@story645 story645 merged commit b560513 into matplotlib:master Jul 15, 2020
@story645
Copy link
Member

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

meeseeksmachine pushed a commit to meeseeksmachine/matplotlib that referenced this pull request Jul 15, 2020
tacaswell added a commit that referenced this pull request Jul 15, 2020
…858-on-v3.3.x

Backport PR #17858 on branch v3.3.x (Refresh what's new page for 3.3.0)
@QuLogic QuLogic deleted the doc-330 branch July 15, 2020 18:56
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.

None yet

4 participants