Skip to content

Commit 05b2be1

Browse files
committed
Mention version markers for @internal and @deprecated
1 parent 1c8bc36 commit 05b2be1

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

docs/API-and-deprecation-policy.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,8 @@ are by definition considered to be internal as well.
2424

2525
When we change some code from public to `@internal` in a release, the first
2626
release that might change that code in a breaking way will be the next major
27-
release after that. This will allow you to change your code accordingly.
27+
release after that. This will allow you to change your code accordingly. We'll
28+
also add since which version the code is internal.
2829

2930
For example, we might mark some code as `@internal` in version 8.7.0. The first
3031
version that possibly changes this code in a breaking way will then be version
@@ -40,7 +41,8 @@ Code that we plan to remove is marked as `@deprecated`. In the corresponding
4041
annotation, we also note in which release the code will be removed.
4142

4243
When we mark some code as `@deprecated` in a release, we'll usually remove it in
43-
the next major release.
44+
the next major release. We'll also add since which version the code is
45+
deprecated.
4446

4547
For example, when we mark some code as `@deprecated` in version 8.7.0, we'll
4648
remove it in version 9.0.0 (or sometimes a later major release).

0 commit comments

Comments
 (0)