Add programmatic and docstring deprecations #734
Merged
Conversation
This file contains 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
|
I'm going to merge this PR that is just adding programmatic deprecation warnings to some API that's already been docs-deprecated for a while. |
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.
Our plan for Param 2.0 was to improve its API by renaming and removing some methods/functions. This has already been partially achieved, however some API we deprecated was just deprecated by adding a comment in the release notes (of Param 1.12.0 mostly) and in the code, sometimes in docstrings.
We deem that this was not enough to completely remove that API in Param 2.0, as users tend to rely on programmatic warnings. For instance, in some of the HoloViz libraries there were still usages of the deprecated
.param.params().This PR:
warningsmodule of Python to the deprecated methods/functions/attributesdeprecatedSphinx directive to the relevant docstringsFixes #692
Fixes #702