Skip to content

chore: Improve stability levels section in README#16851

Merged
parthea merged 1 commit intomainfrom
parthea-patch-16
Apr 28, 2026
Merged

chore: Improve stability levels section in README#16851
parthea merged 1 commit intomainfrom
parthea-patch-16

Conversation

@parthea
Copy link
Copy Markdown
Contributor

@parthea parthea commented Apr 28, 2026

Fixes #10798

@parthea parthea marked this pull request as ready for review April 28, 2026 17:40
@parthea parthea requested a review from a team as a code owner April 28, 2026 17:40
Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request updates the README.rst to rename 'General Availability' to 'Stable' and consolidate 'Beta' and 'Alpha' support under a new 'Preview' section. A review comment suggests fixing trailing whitespaces and improving the formatting consistency of the Alpha and Beta descriptions for better readability.

Comment thread README.rst
Comment on lines +38 to +46
**Preview** indicates that the client library for a particular service is
under development—either in **Beta** or **Alpha**—and is being prepared for
release.

Beta libraries have development status classifier ``Development Status :: 4 - Beta``.
* **Beta** indicates the library is mostly stable. Issues and requests
against beta libraries are addressed with a higher priority.
(``Development Status :: 4 - Beta``)
* **Alpha** indicates the library is still a work-in-progress and is more
likely to get backwards-incompatible updates. (``Development Status :: 3 - Alpha``)
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

This section contains several trailing whitespaces (lines 39, 40, 42, 43, and 45). Additionally, the formatting for the Alpha and Beta descriptions is inconsistent; the Beta classifier is on a new line while the Alpha one is inline. Consolidating the layout improves readability and consistency.

Suggested change
**Preview** indicates that the client library for a particular service is
under development—either in **Beta** or **Alpha**—and is being prepared for
release.
Beta libraries have development status classifier ``Development Status :: 4 - Beta``.
* **Beta** indicates the library is mostly stable. Issues and requests
against beta libraries are addressed with a higher priority.
(``Development Status :: 4 - Beta``)
* **Alpha** indicates the library is still a work-in-progress and is more
likely to get backwards-incompatible updates. (``Development Status :: 3 - Alpha``)
**Preview** indicates that the client library for a particular service is
under development—either in **Beta** or **Alpha**—and is being prepared for
release.
* **Beta** indicates the library is mostly stable. Issues and requests
against beta libraries are addressed with a higher priority.
(Development Status :: 4 - Beta)
* **Alpha** indicates the library is still a work-in-progress and is more
likely to get backwards-incompatible updates.
(Development Status :: 3 - Alpha)

@parthea parthea merged commit a88d741 into main Apr 28, 2026
30 checks passed
@parthea parthea deleted the parthea-patch-16 branch April 28, 2026 18:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

stability level nomenclature inconsistent in README

2 participants