Putting an actual version number on the next_api_changes directory may help avoiding notes going to the wrong file during long RC periods where it's not so obvious whether next_api_changes refers to the currently rc'd release, or the next one.
Closes#16588

PR Checklist

Has Pytest style unit tests
Code isFlake 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)
Documented in doc/api/api_changes.rst if API changed in a backward-incompatible way

SidharthBansal added2 commits

April 4, 2020 03:00

Rename next_api_changes to api_changes_3.3

45252f1

Merge branch 'master' ofhttps://github.com/matplotlib/matplotlibint…

8b4d7d7

…o file_name_made_more_understandable

Copy link

ContributorAuthor

SidharthBansal commentedApr 3, 2020

@anntzer @story645 @tacaswell kindly review this pr

timhoffm reviewed

Apr 3, 2020

View reviewed changes

Copy link

Member

timhoffm left a comment

Choose a reason for hiding this comment

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

If we put the explicit number all over the docs, this will get outdated as I don‘t think it will be updated consistently.

I‘d go for using „the most recent api_changes_X.Y“ or a similar term.

Copy link

ContributorAuthor

SidharthBansal commentedApr 4, 2020 via email

I think "recent api_changes_X.Y“ is explanatory enough. We don't need "themost". What do you think?

…

On Sat, 4 Apr 2020, 4:26 am Tim Hoffmann, ***@***.***> wrote: ***@***.**** commented on this pull request. If we put the explicit number all over the docs, this will get outdated as I don‘t think it will be updated consistently. I‘d go for using „the most recent api_changes_X.Y“ or a similar term. — You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub <#17021 (review)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AFAAEQ5PKOYQENYX6IBPQHDRKZSTRANCNFSM4L4PSFNA> .

Copy link

Member

timhoffm commentedApr 4, 2020

Fine by me.

prepend recent_ in filename

04e9e4f

Copy link

ContributorAuthor

SidharthBansal commentedApr 4, 2020

@timhoffm I think I am missing something very crucial due to which majority of CI are failing. I have pushed the changes. Trying to debug the failing CIs. Any help appreciated.
Thanks

Copy link

ContributorAuthor

SidharthBansal commentedApr 4, 2020

CircleCI shows

make: *** [Makefile:30: html] Error 1
Exited with code exit status 2
Your output is too large to display in the browser. Only the last 400000 characters are displayed.
Download the full output as a file.

Do I need to upload any output files too? Maybe for the test outputs?

Copy link

Contributor

anntzer commentedApr 4, 2020

You can download the log file and look for "warnings". Here you'll find

/home/circleci/project/doc/api/api_changes.rst:14: WARNING: toctree glob pattern 'next_api_changes/*' didn't match any documentslooking for now-outdated files... none foundpickling environment... donechecking consistency... /home/circleci/project/doc/api/recent_api_changes_3.3/2019-04-25-AL.rst: WARNING: document isn't included in any toctree/home/circleci/project/doc/api/recent_api_changes_3.3/behaviour.rst: WARNING: document isn't included in any toctree/home/circleci/project/doc/api/recent_api_changes_3.3/deprecations.rst: WARNING: document isn't included in any toctree/home/circleci/project/doc/api/recent_api_changes_3.3/development.rst: WARNING: document isn't included in any toctree/home/circleci/project/doc/api/recent_api_changes_3.3/removals.rst: WARNING: document isn't included in any toctree

which means that you forgot to edit doc/api/api_changes.rst, and therefore the moved files are not referenced anywhere.

prepend recent_ in filename

4ed4696

Copy link

ContributorAuthor

SidharthBansal commentedApr 4, 2020

Thanks for the help.
I think it is ready for merge now. Thanks all for helping me :-)

SidharthBansal mentioned this pull request

Apr 4, 2020

Changed return type of get_{x,y}ticklabels to plain list#17028

Merged

6 tasks

tacaswell added this to thev3.3.0 milestone

Apr 4, 2020

tacaswell reviewed

Apr 4, 2020

View reviewed changes

doc/devel/release_guide.rst OutdatedShow resolvedHide resolved

Copy link

Member

tacaswell commentedApr 4, 2020

I am skeptical of this change, it may make it slightly clearer but it is going to require a whole bunch of places to be updated after we fork off v3.3.x and 3.4 becomes the "next" release.

timhoffm requested changes

Apr 4, 2020

View reviewed changes

doc/devel/coding_guide.rst OutdatedShow resolvedHide resolved

doc/api/api_changes.rst OutdatedShow resolvedHide resolved

SidharthBansal added2 commits

April 5, 2020 00:37

Changed text

020281c

removed move line

be1a3c9

SidharthBansal requested a review fromtimhoffm

April 4, 2020 19:14

modified the guidelines

91920e4

timhoffm reviewed

Apr 5, 2020

View reviewed changes

doc/api/api_changes.rst OutdatedShow resolvedHide resolved

timhoffm mentioned this pull request

Apr 5, 2020

Shorten implementation of Axes methods that just wrap Axis methods.#16903

Merged

6 tasks

timhoffm approved these changes

Apr 5, 2020

View reviewed changes

Copy link

Member

timhoffm commentedApr 5, 2020

Ping@tacaswell this has only one explicit filename left (and it's in the toc). Do you think this is bearable?

Copy link

Member

tacaswell commentedApr 6, 2020

Yes, that seems OK.

Copy link

ContributorAuthor

SidharthBansal commentedApr 6, 2020 via email

Can we merge it? If it is ok?Thanks all for helping 😊

…

On Mon, 6 Apr 2020, 6:49 pm Thomas A Caswell, ***@***.***> wrote: Yes, that seems OK. — You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub <#17021 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AFAAEQ4627YTRIMEDH2U4ZLRLHJH3ANCNFSM4L4PSFNA> .

Copy link

ContributorAuthor

SidharthBansal commentedApr 6, 2020

There are conflicts. Resolving them now

SidharthBansal force-pushed thefile_name_made_more_understandable branch from34c6e1c to91920e4Compare

April 6, 2020 21:06

Merge branch 'master' ofhttps://github.com/matplotlib/matplotlibint…

25303ee

…o file_name_made_more_understandable

resolved conflicts

dae433b

Copy link

ContributorAuthor

SidharthBansal commentedApr 6, 2020

Resolved. Thanks!

QuLogic reviewed

Apr 6, 2020

View reviewed changes

Copy link

Member

QuLogic left a comment

Choose a reason for hiding this comment

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

Some typos to fix.

doc/devel/coding_guide.rst OutdatedShow resolvedHide resolved

doc/devel/release_guide.rst OutdatedShow resolvedHide resolved

SidharthBansaland others added2 commits

April 7, 2020 05:10

Update doc/devel/coding_guide.rst

1a168eb

Co-Authored-By: Elliott Sales de Andrade <quantum.analyst@gmail.com>

Update doc/devel/release_guide.rst

3f72200

Co-Authored-By: Elliott Sales de Andrade <quantum.analyst@gmail.com>

Copy link

ContributorAuthor

SidharthBansal commentedApr 6, 2020

Done. Thanks

timhoffm merged commitb85c7f4 intomatplotlib:master

Apr 7, 2020

Labels

None yet

5 participants

Movatterモバイル変換

Uh oh!

File name made more understandable#17021

File name made more understandable#17021

Uh oh!

Conversation

SidharthBansal commentedApr 3, 2020

PR Summary

PR Checklist

Uh oh!

SidharthBansal commentedApr 3, 2020

Uh oh!

timhoffm left a comment

Choose a reason for hiding this comment

Uh oh!

SidharthBansal commentedApr 4, 2020 via email

Uh oh!

timhoffm commentedApr 4, 2020

Uh oh!

SidharthBansal commentedApr 4, 2020

Uh oh!

SidharthBansal commentedApr 4, 2020

Uh oh!

anntzer commentedApr 4, 2020

Uh oh!

SidharthBansal commentedApr 4, 2020

Uh oh!

Uh oh!

tacaswell commentedApr 4, 2020

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

timhoffm commentedApr 5, 2020

Uh oh!

tacaswell commentedApr 6, 2020

Uh oh!

SidharthBansal commentedApr 6, 2020 via email

Uh oh!

SidharthBansal commentedApr 6, 2020

Uh oh!

SidharthBansal commentedApr 6, 2020

Uh oh!

QuLogic left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

SidharthBansal commentedApr 6, 2020

Uh oh!

Uh oh!