Skip to content

Commit 0a1a578

Browse files
authored
[API docs contrib guidance] Add clarification about @availability since in ES spec (#2618)
1 parent da9fc9b commit 0a1a578

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed

extend/contribute/api-docs/organize-annotate.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -304,6 +304,11 @@ class FooRequest {
304304

305305
This example shows the "later addition" scenario where `laterAddition` was added after the initial API release, requiring a parameter-level availability annotation with a later version than the API-level availability.
306306

307+
:::::{important}
308+
The `since` field is only available for `stack`. If the API is introduced in multiple major versions (eg: `8.19.0` and `9.1.0`), use the appropriate value in each branch.
309+
:::::
310+
311+
307312
**Deprecation notices** use the `@deprecated` annotation:
308313

309314
```ts
@@ -449,4 +454,4 @@ The annotation system doesn't support "OR" relationships between privileges. Whe
449454
:::
450455
:::
451456

452-
::::
457+
::::

0 commit comments

Comments
 (0)