Skip to content

Commit fc4c079

Browse files
committed
docs: reorder versioning subsections
Obsolete and Internal Api go first now, since they are more important
1 parent d76a6af commit fc4c079

File tree

1 file changed

+13
-13
lines changed

1 file changed

+13
-13
lines changed

README.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1526,13 +1526,11 @@ $ mvn test
15261526
This library follows [Semantic Versioning](http://semver.org/), but with some
15271527
additional qualifications:
15281528

1529-
1. Components marked with `@BetaApi` are considered to be "0.x" features inside
1530-
a "1.x" library. This means they can change between minor and patch releases
1531-
in incompatible ways. These features should not be used by any library "B"
1532-
that itself has consumers, unless the components of library B that use
1533-
`@BetaApi` features are also marked with `@BetaApi`. Features marked as
1534-
`@BetaApi` are on a path to eventually become "1.x" features with the marker
1535-
removed.
1529+
1. Components marked with `@ObsoleteApi` are stable for usage in the current major version,
1530+
but will be marked with `@Deprecated` in a future major version.
1531+
**NOTE**: We reserve the right to mark anything as `@Deprecated` and introduce breaking
1532+
changes in a minor version to fix any ***critical bugs and
1533+
vulnerabilities***.
15361534

15371535
1. Components marked with `@InternalApi` are technically public, but are only
15381536
public for technical reasons, because of the limitations of Java's access
@@ -1543,13 +1541,15 @@ additional qualifications:
15431541
with this annotation, but methods can be added, thus breaking any
15441542
code implementing the interface. See the javadocs for more details on other
15451543
consequences of this annotation.
1546-
1547-
1. Components marked with `@ObsoleteApi` are stable for usage in the current major version,
1548-
but will be marked with `@Deprecated` in a future major version.
1549-
**NOTE**: We reserve the right to mark anything as `@Deprecated` and introduce breaking
1550-
changes in a minor version to fix any ***critical bugs and
1551-
vulnerabilities***.
15521544

1545+
1. Components marked with `@BetaApi` are considered to be "0.x" features inside
1546+
a "1.x" library. This means they can change between minor and patch releases
1547+
in incompatible ways. These features should not be used by any library "B"
1548+
that itself has consumers, unless the components of library B that use
1549+
`@BetaApi` features are also marked with `@BetaApi`. Features marked as
1550+
`@BetaApi` are on a path to eventually become "1.x" features with the marker
1551+
removed.
1552+
15531553
## License
15541554

15551555
BSD 3-Clause - See [LICENSE](LICENSE) for more information.

0 commit comments

Comments
 (0)