Automatic API deprecations generator. #15246
Closed
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
Run tools/api_changes_generator.py. Collection of `@deprecated` basically works. Collection of `warn_deprecated` has some rough spots. Collection of `@_delete_parameter`, `@_rename_parameter`, `@_make_keyword_only` is not implemented yet but should be easy to do.
|
Seems useful but is it enough to say something has been deprecated? Usually we explain why as well? I guess I’d be ok w the decorator containing that info though it’s a bit verbose. Ie a reason kwarg that doesn’t get printed as the message but still lives in the source code? |
|
In general we don't have more than that in the handwritten API notes either -- and the automated approach scrapes the message argument anyways. |
|
Closing as inactive; we can always reopen if we want to revisit. |
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
Just a prototype (proposed during the dev call), written to perhaps alleviate the problems in #15158 (documentation of api changes is a pain). Perhaps not to be taken too seriously... dunno.
Run tools/api_changes_generator.py.
Collection of
@deprecatedbasically works.Collection of
warn_deprecatedhas some rough spots.Collection of
@_delete_parameter,@_rename_parameter,@_make_keyword_onlyis not implemented yet but should be easy to do.Goes on top of #15245, which were caught by this...
PR Checklist