-
-
Notifications
You must be signed in to change notification settings - Fork 7.9k
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
Conversation
I am weakly 👎 on removing the |
We don't use |
I added it back then because we were starting to use it in some other
places. I don't know why it was removed elsewhere, but I have always valued
these sorts of documentation notes.
…On Mon, Mar 1, 2021 at 12:23 PM Jody Klymak ***@***.***> wrote:
We don't use .. versionadded:: anywhere else, and have not used it
consistently in this toolbox. Does it really make sense to keep it?
—
You are receiving this because you are subscribed to this thread.
Reply to this email directly, view it on GitHub
<#19606 (comment)>,
or unsubscribe
<https://github.com/notifications/unsubscribe-auth/AACHF6GIQFQE4U63V5NTIRDTBPERPANCNFSM4YMAXDLA>
.
|
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. |
My thought is that since 2.0 made default changes, you probably don't want to go any older than that, so any |
Oops, misclick there. |
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. |
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. |
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
pytest
passes).flake8
on changed files to check).flake8-docstrings
and runflake8 --docstring-convention=all
).doc/users/next_whats_new/
(follow instructions in README.rst there).doc/api/next_api_changes/
(follow instructions in README.rst there).