[utils] add beta warning and decorator #26748
Conversation
|
Warning This pull request is not mergeable via GitHub because a downstack PR is open. Once all requirements are satisfied, merge this PR as a stack on Graphite.
This stack of pull requests is managed by Graphite. Learn more about stacking. |
maximearmstrong
force-pushed
the
maxime/ad-736/add-beta-annotation
branch
from
351fbe0 to
5f95dcf
Compare
maximearmstrong
requested review from
danielgafni,
yuhan,
cmpadden and
OwenKephart
| return | ||
|
|
||
| warnings.warn( | ||
| f"{subject} is in beta stage - the feature is still being tested and may change." |
There was a problem hiding this comment.
this seems ok - take it or leave it
is in beta stage - the feature is being tested for production readiness and may be updated.
There was a problem hiding this comment.
How about:
is in beta. It may break in a future minor release, or have minor behavior changes between dot releases.
I don't love this "production readiness" framing, as I think the key important detail here is when / how likely this feature is to be broken, and what those breakages might look like
In my mind:
- preview: might break even between dot releases
- beta: might break on a dot release, or have behavior changes
Summary & Motivation
Fixes AD-736 in the API Lifecycle project.
Adding new Beta 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.