Skip to content

Commit 52f94f9

Browse files
committed
docs(api-and-naming): note deprecated files having private API
1 parent a5a1b96 commit 52f94f9

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

doc/api-and-naming.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,11 @@ each call that references the value, variable name, or their existence,
1919
typically by `unset -v`ing them when multiple such calls are used,
2020
to avoid them interfering with each other.
2121

22+
Everything in deprecated completion files (ones starting with an underscore)
23+
is considered private and is to be named accordingly. Deprecated files are not
24+
intended to be explicitly used with `_comp_xfunc`, and completion files having
25+
precedence over them may have a different API.
26+
2227
## Naming
2328

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

0 commit comments

Comments
 (0)