Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Remove versionadded notes; correct doc link #19606

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 2 commits into from
Mar 2, 2021

Conversation

kentcr
Copy link
Contributor

@kentcr kentcr commented Mar 1, 2021

PR Summary

Remove unmaintained version notes/annotations from axes3d.py. This also corrects an inline markup escape sequence to generate a doc link properly.

PR Checklist

  • [N/A] Has pytest style unit tests (and pytest passes).
  • Is Flake 8 compliant (run flake8 on changed files to check).
  • [N/A] New features are documented, with examples if plot related.
  • Documentation is sphinx and numpydoc compliant (the docs should build without error).
  • Conforms to Matplotlib style conventions (install flake8-docstrings and run flake8 --docstring-convention=all).
  • [N/A] New features have an entry in doc/users/next_whats_new/ (follow instructions in README.rst there).
  • [N/A] API changes documented in doc/api/next_api_changes/ (follow instructions in README.rst there).

@tacaswell
Copy link
Member

I am weakly 👎 on removing the .. versionadded: notes. Although we do not plan to provide bug-fix releases for any of the old versions, there is definitely a lot of use of older versions in the wild.

@tacaswell tacaswell added this to the v3.5.0 milestone Mar 1, 2021
@jklymak
Copy link
Member

jklymak commented Mar 1, 2021

We don't use .. versionadded:: anywhere else, and have not used it consistently in this toolbox. Does it really make sense to keep it?

@WeatherGod
Copy link
Member

WeatherGod commented Mar 1, 2021 via email

@timhoffm
Copy link
Member

timhoffm commented Mar 1, 2021

versionadded is generally a helpful concept. However, only having it for very few functions is not a great help. It's rather making me wonder why I don't see that info on other functions and if that missing tag means they are older than any explicitly mentioned version.

Since we don't have it and nobody wants to take the effort of adding it for large parts of the library, I'm +0.5 on removing the entries for consistency.

@QuLogic
Copy link
Member

QuLogic commented Mar 1, 2021

My thought is that since 2.0 made default changes, you probably don't want to go any older than that, so any versionadded before that is noise. But anything newer than 2.0 probably has a What's new? entry, so probably doesn't need the tag either.

@QuLogic QuLogic closed this Mar 1, 2021
@QuLogic
Copy link
Member

QuLogic commented Mar 1, 2021

Oops, misclick there.

@QuLogic QuLogic reopened this Mar 1, 2021
@kentcr
Copy link
Contributor Author

kentcr commented Mar 2, 2021

The effect of these is just to include a "what's new" or "changed in" note to the documentation. Including such notes for things added in 2011 does not make any sense to me unless the intention is to do that for the entire API. Having these for new things does make sense, but I was asked to remove such a note in my recent PR, so consistency is already a problem.

Consistency would also be important because if I saw a "what's new in 3.3.5", I'd be led to believe all such additions to 3.3.5 would say so. So it should then be another thing to require and check in every new PR.

Then the question becomes how long you keep them. Not that I've looked closely, but Python docs seem to keep them for the current major version number (see https://docs.python.org/3/library/hashlib.html for examples) and I've been happy with that.

@QuLogic QuLogic merged commit bc97294 into matplotlib:master Mar 2, 2021
@QuLogic
Copy link
Member

QuLogic commented Mar 2, 2021

I think overall we're in favour here, and I'd rather fix CI. One can always revert if strongly feel like adding those everywhere.

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.

6 participants