File name made more understandable #17021

SidharthBansal · 2020-04-03T22:42:50Z

PR Summary

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 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)
Documented in doc/api/api_changes.rst if API changed in a backward-incompatible way

…o file_name_made_more_understandable

SidharthBansal · 2020-04-03T22:43:17Z

@anntzer @story645 @tacaswell kindly review this pr

timhoffm

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.

SidharthBansal · 2020-04-04T00:50:11Z

I think "recent api_changes_X.Y“ is explanatory enough. We don't need "the most". 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> .

timhoffm · 2020-04-04T01:40:36Z

Fine by me.

SidharthBansal · 2020-04-04T10:04:00Z

@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

SidharthBansal · 2020-04-04T10:05:17Z

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?

anntzer · 2020-04-04T10:09:38Z

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 documents
looking for now-outdated files... none found
pickling environment... done
checking 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.

SidharthBansal · 2020-04-04T11:15:04Z

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

doc/devel/release_guide.rst

tacaswell · 2020-04-04T18:29:30Z

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.

doc/devel/coding_guide.rst

doc/api/api_changes.rst

timhoffm · 2020-04-05T22:32:23Z

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

tacaswell · 2020-04-06T13:19:41Z

Yes, that seems OK.

SidharthBansal · 2020-04-06T13:56:04Z

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> .

SidharthBansal · 2020-04-06T21:04:14Z

There are conflicts. Resolving them now

…o file_name_made_more_understandable

SidharthBansal · 2020-04-06T21:15:42Z

Resolved. Thanks!

QuLogic

Some typos to fix.

doc/devel/coding_guide.rst

doc/devel/release_guide.rst

Co-Authored-By: Elliott Sales de Andrade <[email protected]>

SidharthBansal · 2020-04-06T23:41:58Z

Done. Thanks

SidharthBansal added 2 commits April 4, 2020 03:00

Rename next_api_changes to api_changes_3.3

45252f1

Merge branch 'master' of https://github.com/matplotlib/matplotlib int…

8b4d7d7

…o file_name_made_more_understandable

timhoffm reviewed Apr 3, 2020

View reviewed changes

prepend recent_ in filename

04e9e4f

prepend recent_ in filename

4ed4696

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 the v3.3.0 milestone Apr 4, 2020

tacaswell reviewed Apr 4, 2020

View reviewed changes

doc/devel/release_guide.rst Outdated Show resolved Hide resolved

timhoffm requested changes Apr 4, 2020

View reviewed changes

doc/devel/coding_guide.rst Outdated Show resolved Hide resolved

doc/api/api_changes.rst Outdated Show resolved Hide resolved

SidharthBansal added 2 commits April 5, 2020 00:37

Changed text

020281c

removed move line

be1a3c9

SidharthBansal requested a review from timhoffm April 4, 2020 19:14

modified the guidelines

91920e4

timhoffm reviewed Apr 5, 2020

View reviewed changes

doc/api/api_changes.rst Outdated Show resolved Hide resolved

doc/api/api_changes.rst Outdated Show resolved Hide 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

SidharthBansal force-pushed the file_name_made_more_understandable branch from 34c6e1c to 91920e4 Compare April 6, 2020 21:06

Merge branch 'master' of https://github.com/matplotlib/matplotlib int…

25303ee

…o file_name_made_more_understandable

resolved conflicts

dae433b

QuLogic reviewed Apr 6, 2020

View reviewed changes

doc/devel/coding_guide.rst Outdated Show resolved Hide resolved

doc/devel/release_guide.rst Outdated Show resolved Hide resolved

SidharthBansal and others added 2 commits April 7, 2020 05:10

Update doc/devel/coding_guide.rst

1a168eb

Co-Authored-By: Elliott Sales de Andrade <[email protected]>

Update doc/devel/release_guide.rst

3f72200

Co-Authored-By: Elliott Sales de Andrade <[email protected]>

timhoffm merged commit b85c7f4 into matplotlib:master Apr 7, 2020

Uh oh!

File name made more understandable #17021

File name made more understandable #17021

Uh oh!

Conversation

SidharthBansal commented Apr 3, 2020

PR Summary

PR Checklist

Uh oh!

SidharthBansal commented Apr 3, 2020

Uh oh!

timhoffm left a comment

Choose a reason for hiding this comment

Uh oh!

SidharthBansal commented Apr 4, 2020 via email

Uh oh!

timhoffm commented Apr 4, 2020

Uh oh!

SidharthBansal commented Apr 4, 2020

Uh oh!

SidharthBansal commented Apr 4, 2020

Uh oh!

anntzer commented Apr 4, 2020

Uh oh!

SidharthBansal commented Apr 4, 2020

Uh oh!

Uh oh!

tacaswell commented Apr 4, 2020

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

timhoffm commented Apr 5, 2020

Uh oh!

tacaswell commented Apr 6, 2020

Uh oh!

SidharthBansal commented Apr 6, 2020 via email

Uh oh!

SidharthBansal commented Apr 6, 2020

Uh oh!

SidharthBansal commented Apr 6, 2020

Uh oh!

QuLogic left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

SidharthBansal commented Apr 6, 2020

Uh oh!

Uh oh!