Skip to content

Commit 00194dc

Browse files
committed
docs(api-and-naming): note @since and @deprecated versioning
- #893 - #963
1 parent e06a482 commit 00194dc

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

doc/api-and-naming.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,18 @@ is considered private and is to be named accordingly. Fallback files are not
2424
intended to be explicitly used with `_comp_xfunc`, and completion files having
2525
precedence over them may have a different API.
2626

27+
## Availability
28+
29+
All public API functions and variables are marked with a `@since VERSION`
30+
comment, where `VERSION` is the bash-completion version the thing was
31+
introduced in.
32+
33+
Similarly, deprecated functions and variables are either marked with a
34+
`@deprecated VERSION ...` comment, or deprecated using the
35+
`_comp_deprecate_func VERSION OLD_NAME NEW_NAME` function.
36+
`VERSION` in both cases is the bash-completion version the thing was
37+
deprecated in.
38+
2739
## Naming
2840

2941
Due to its nature, bash-completion adds a number of functions and variables in

0 commit comments

Comments
 (0)