Add new standards for deprecating APIs #1365
Open
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
ndrluis
force-pushed
the
new-deprecation
branch
from
f9375a3 to
c6fb7b2
Compare
|
Some Deprecation Examples Future Deprecation Deprecated Missing to remove |
ndrluis
force-pushed
the
new-deprecation
branch
from
c6fb7b2 to
d2ad204
Compare
Fokko
reviewed
Dec 11, 2024
pyiceberg/catalog/__init__.py
Outdated
| help_message="Support for parsing catalog level identifier in Catalog identifiers is deprecated. Please refer to the table using only its namespace and its table name.", | ||
| deprecate_in="0.8.0", | ||
| remove_in="0.9.0", | ||
| topic="Please refer to the table using only its namespace and its table name.", |
There was a problem hiding this comment.
@ndrluis Sorry for not getting to this earlier. My main concern is that we might make things more complex than necessary. Why would we not use the addendum here? I find the prefix and topic not very intuitive, as in, it is not directly obvious to me how the deprecation warning will look like. That raises the question, should we reduce the number of options?
There was a problem hiding this comment.
I changed the topic attribute to 'addendum' and will improve the documentation to clarify the output message for each case.
ndrluis
force-pushed
the
new-deprecation
branch
from
d2ad204 to
afbc33f
Compare
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.
Solves #1330.
@Fokko, could you check if I got the License and file headers right?