Skip to content

Commit 5435b7c

Browse files
committed
docs(api-and-naming): reword "internal => private" for symmetry
1 parent 4f6e424 commit 5435b7c

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

doc/api-and-naming.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,15 @@
33
Due to its nature, bash-completion adds a number of functions and variables in
44
the shell's environment.
55

6-
| | `bash_completion` | `completions/*` |
7-
|:-------------------------------------|:--------------------|:---------------------------------------------------------------------------|
8-
| public configuration variables | `BASH_COMPLETION_*` | `BASH_COMPLETION_CMD_${Command^^}_${Config^^}` |
9-
| non-local internal variables | `_comp__*` | `_comp_cmd_${Command}__${Data}` |
10-
| non-local internal mutable variables | `_comp__*_mut_*` | `_comp_cmd_${Command}__mut_${Data}` |
11-
| exporter function local variables | `_*` (not `_comp*`) | `_*` (not `_comp*`) |
12-
| public/exported functions | `_comp_*` | `_comp_cmd_${Command}` (functions for `complete -F`) |
13-
| | | `_comp_xfunc_${Command}_${Utility}` (functions for use with `_comp_xfunc`) |
14-
| private/internal functions | `_comp__*` | `_comp_cmd_${Command}__${Utility}` (utility functions) |
6+
| | `bash_completion` | `completions/*` |
7+
|:------------------------------------|:--------------------|:---------------------------------------------------------------------------|
8+
| public configuration variables | `BASH_COMPLETION_*` | `BASH_COMPLETION_CMD_${Command^^}_${Config^^}` |
9+
| private non-local variables | `_comp__*` | `_comp_cmd_${Command}__${Data}` |
10+
| private non-local mutable variables | `_comp__*_mut_*` | `_comp_cmd_${Command}__mut_${Data}` |
11+
| exporter function local variables | `_*` (not `_comp*`) | `_*` (not `_comp*`) |
12+
| public/exported functions | `_comp_*` | `_comp_cmd_${Command}` (functions for `complete -F`) |
13+
| | | `_comp_xfunc_${Command}_${Utility}` (functions for use with `_comp_xfunc`) |
14+
| private/internal functions | `_comp__*` | `_comp_cmd_${Command}__${Utility}` (utility functions) |
1515

1616
`${Command}` refers to a command name (with characters not allowed in POSIX
1717
function or variable names replaced by an underscore), `${Config}` the name of
@@ -40,7 +40,7 @@ sharing a common prefix. For example, a function named `_comp_foo` is "allowed"
4040
to access `_comp_foo__*` where `*` does not contain any double underscores,
4141
i.e. it should not access `_comp_foo__something__*` despite the common prefix.
4242

43-
Non-local internal variables are considered readonly by default. When a
43+
Private non-local variables are considered readonly by default. When a
4444
completion function needs to change variables for e.g. caching purposes, the
4545
variables should contain the infix `*_mut_*` anywhere in their names. This is
4646
needed to tell the test framework to allow these variables changing.

0 commit comments

Comments
 (0)