[utils] add preview warning and decorator #26747
Open
+144
−1
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
This stack of pull requests is managed by Graphite. Learn more about stacking. |
yuhan
reviewed
Dec 27, 2024
| return | ||
|
|
||
| warnings.warn( | ||
| f"{subject} is a preview in early testing phase with frequent changes, not recommended for production use." |
There was a problem hiding this comment.
i know this is the original language we had in the doc. but when it's putting in a user-facing warning like this, it feels a little scary. how about tuning it down:
is a preview currently in early testing, with ongoing updates, and not yet optimized for production use.
There was a problem hiding this comment.
I think the "production use" verbiage is okay here, but just swinging back from the upstack review, maybe:
is currently in preview, with ongoing updates. This may break in future versions, even between dot releases.
OwenKephart
reviewed
Dec 31, 2024
OwenKephart
requested changes
Dec 31, 2024
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.
Summary & Motivation
Fixes AD-735 in the API Lifecycle project.
Adding new Preview Python utils. Similar to #25363
This is done in alignment with the new API lifecycle.
The raised warning is a
Warning.Docs to be updated in subsequent PR.