Skip to content

Commit d92161a

Browse files
[Docs] Don't show "PublicAPI" message for stable APIs (ray-project#39976)
Many of our APIs contain a disclaimer like: > PublicAPI: This API is stable across Ray releases. However, this disclaimer isn't useful because you'd assume an API is stable in the absence of any warning. To remove noise from our documentation, this PR removes the disclaimer. --------- Signed-off-by: Balaji Veeramani <balaji@anyscale.com> Signed-off-by: Balaji Veeramani <bveeramani@berkeley.edu> Co-authored-by: angelinalg <122562471+angelinalg@users.noreply.github.com>
1 parent 0747470 commit d92161a

File tree

2 files changed

+3
-3
lines changed

2 files changed

+3
-3
lines changed

python/ray/serve/config.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,8 @@
2828

2929
@PublicAPI(stability="stable")
3030
class AutoscalingConfig(BaseModel):
31+
"""Config for the Serve Autoscaler."""
32+
3133
# Please keep these options in sync with those in
3234
# `src/ray/protobuf/serve.proto`.
3335

python/ray/util/annotations.py

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -52,10 +52,8 @@ def wrap(obj):
5252
f"**PublicAPI ({stability}):** This API is in {stability} "
5353
"and may change before becoming stable."
5454
)
55-
else:
56-
message = "PublicAPI: This API is stable across Ray releases."
55+
_append_doc(obj, message=message)
5756

58-
_append_doc(obj, message=message)
5957
_mark_annotated(obj)
6058
return obj
6159

0 commit comments

Comments
 (0)