Skip to content

Commit

Permalink
fix(Makefile): include api-and-naming.md in dist
Browse files Browse the repository at this point in the history
  • Loading branch information
akinomyoga authored and scop committed Mar 9, 2024
1 parent 03a10ff commit fdd8048
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 7 deletions.
1 change: 1 addition & 0 deletions doc/Makefile.am
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
EXTRA_DIST = \
api-and-naming.md \
configuration.md \
styleguide.md \
testing.md
14 changes: 7 additions & 7 deletions doc/api-and-naming.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,8 @@ specific names. `local`izing output variables before invoking a function that
populates them is the caller's responsibility. Note that if calling multiple
functions that assign output to the same variable during one completion
function run, each result should be copied to another variable between the
calls to avoid it possibly being overwritten and lost on the next call. Also,
the variables should also be ensured to be clear before each call that
calls to avoid it possibly being overwritten and lost on the next call.
The variables should also be ensured to be clear before each call that
references the value, variable name, or their existence, typically by `unset
-v`ing them when multiple such calls are used, to avoid them interfering with
each other.
Expand All @@ -24,8 +24,8 @@ unconventional, but this choice of the name is intended to be consistent with
the value substitutions `${| func; }`, which is originally supported by mksh
and will be supported by Bash >= 5.3. The value substitutions are replaced by
the contents of the output variable `REPLY` set by `func`. Although we cannot
currently assume Bash 5.3 in the codebase, but we can switch to the value
substitutions at the point Bash <= 5.2 disappear from the market.
currently assume Bash 5.3 in the codebase, we can switch to the value
substitutions at the point Bash <= 5.2 disappears from the market.

Everything in fallback completion files (ones starting with an underscore)
is considered private and is to be named accordingly. Fallback files are not
Expand Down Expand Up @@ -164,9 +164,9 @@ append the results to the target variable, use `_comp_compgen_split -- "$(cmd

A generator function should replace the existing content of the variable by
default. When the appending behavior is favored, the caller should specify it
through `_comp_compgen -a NAME`. The generator function do not need to process
it because internal `_comp_compgen` calls automatically reflects the option
`-a` specified to the outer calls of `_comp_compgen`.
through `_comp_compgen -a NAME`. The generator function does not need to
process it because internal `_comp_compgen` calls automatically reflect the
option `-a` specified to the outer calls of `_comp_compgen`.

The exit status is implementation-defined.

Expand Down

0 comments on commit fdd8048

Please sign in to comment.