Skip to content

Commit a88d741

Browse files
authored
chore: Improve stability levels section in README (#16851)
Fixes #10798
1 parent cf12ffd commit a88d741

1 file changed

Lines changed: 19 additions & 23 deletions

File tree

README.rst

Lines changed: 19 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -14,42 +14,38 @@ of a package.
1414

1515
.. _development status classifier: https://pypi.org/classifiers/
1616

17-
General Availability
18-
--------------------
17+
Stable
18+
------
1919

20-
**GA** (general availability) indicates that the client library for a
21-
particular service is stable, and that the code surface will not change in
20+
**Stable** (general availability) indicates that the client library for a
21+
particular service is GA, and that the code surface will not change in
2222
backwards-incompatible ways unless either absolutely necessary (e.g. because
2323
of critical security issues) or with an extensive deprecation period.
24-
Issues and requests against GA libraries are addressed with the highest
24+
Issues and requests against stable libraries are addressed with the highest
2525
priority.
2626

27-
GA libraries have development status classifier ``Development Status :: 5 - Production/Stable``.
27+
Stable libraries have development status classifier ``Development Status :: 5 - Production/Stable``.
2828

2929
.. note::
3030

31-
Sub-components of GA libraries explicitly marked as beta in the
31+
Sub-components of stable libraries explicitly marked as beta in the
3232
import path (e.g. ``google.cloud.language_v1beta2``) should be considered
33-
to be beta.
33+
to be preview.
3434

35-
Beta Support
36-
------------
35+
Preview
36+
-------
3737

38-
**Beta** indicates that the client library for a particular service is
39-
mostly stable and is being prepared for release. Issues and requests
40-
against beta libraries are addressed with a higher priority.
38+
**Preview** indicates that the client library for a particular service is
39+
under development—either in **Beta** or **Alpha**—and is being prepared for
40+
release.
4141

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

44-
Alpha Support
45-
-------------
46-
47-
**Alpha** indicates that the client library for a particular service is
48-
still a work-in-progress and is more likely to get backwards-incompatible
49-
updates. See `versioning`_ for more details.
50-
51-
52-
Alpha libraries have development status classifier ``Development Status :: 3 - Alpha``.
48+
See `versioning`_ for more details.
5349

5450
If you need support for other Google APIs, check out the
5551
`Google APIs Python Client library`_.

0 commit comments

Comments
 (0)