Move deprecation note to end of docstring #12736
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ImportanceOfBeingErnest
approved these changes
Nov 4, 2018
anntzer
approved these changes
Nov 4, 2018
There was a problem hiding this comment.
Seems like a clear improvement. @ImportanceOfBeingErnest I'll let you open a new issue regarding your comment :) (which is reasonable, but perhaps that's the kind of things that should go to sphinx.ext.autosummary?)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
PR Summary
This PR moves the deprecation note, that is generated by
@deprecatedfrom the top of the docstring to the bottom.The issue with the top position is that the first line should contain a description of the function. This place is currently taken over by the deprecation note. Tools that extract a summary sentence with thus pick up the note, e.g. autosummary:
All deprecated elements that I've checked have quite a short docstring so that there's no significant change in visibility of the deprecation note in the rendered HTML docs.
Before:
After:
