Skip to content

Commit fdd8048

Browse files
akinomyogascop
authored andcommitted
fix(Makefile): include api-and-naming.md in dist
1 parent 03a10ff commit fdd8048

File tree

2 files changed

+8
-7
lines changed

2 files changed

+8
-7
lines changed

doc/Makefile.am

+1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
EXTRA_DIST = \
2+
api-and-naming.md \
23
configuration.md \
34
styleguide.md \
45
testing.md

doc/api-and-naming.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,8 @@ specific names. `local`izing output variables before invoking a function that
1313
populates them is the caller's responsibility. Note that if calling multiple
1414
functions that assign output to the same variable during one completion
1515
function run, each result should be copied to another variable between the
16-
calls to avoid it possibly being overwritten and lost on the next call. Also,
17-
the variables should also be ensured to be clear before each call that
16+
calls to avoid it possibly being overwritten and lost on the next call.
17+
The variables should also be ensured to be clear before each call that
1818
references the value, variable name, or their existence, typically by `unset
1919
-v`ing them when multiple such calls are used, to avoid them interfering with
2020
each other.
@@ -24,8 +24,8 @@ unconventional, but this choice of the name is intended to be consistent with
2424
the value substitutions `${| func; }`, which is originally supported by mksh
2525
and will be supported by Bash >= 5.3. The value substitutions are replaced by
2626
the contents of the output variable `REPLY` set by `func`. Although we cannot
27-
currently assume Bash 5.3 in the codebase, but we can switch to the value
28-
substitutions at the point Bash <= 5.2 disappear from the market.
27+
currently assume Bash 5.3 in the codebase, we can switch to the value
28+
substitutions at the point Bash <= 5.2 disappears from the market.
2929

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

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

171171
The exit status is implementation-defined.
172172

0 commit comments

Comments
 (0)