docs(api-and-naming): use REPLY for return variable instead of ret
#987
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
akinomyoga
force-pushed
the
REPLY
branch
2 times, most recently
from
e34c89f to
74a7955
Compare
|
The devel version of Bash still has the support for value substitution of the form |
scop
approved these changes
Dec 24, 2023
doc/api-and-naming.md
Outdated
| @@ -7,7 +7,7 @@ inject them to the `COMPREPLY` array variable, as required for completions to | |||
| work. | |||
|
|
|||
| Most other functions make use of "output" variables, i.e. assign values to | |||
| them. The most common one of these is named `ret`. Consult the commentary | |||
| them. The most common one of these is named `REPLY`. Consult the commentary | |||
There was a problem hiding this comment.
Could we add a few words here why we're using REPLY for this? Uppercase is unconventional, and would be good to note the specific choice of word here as well.
Looks good to me otherwise, pre-approved and good to merge with this addressed.
There was a problem hiding this comment.
Thanks for the suggestion. I separated the sentence of REPLY into a new paragraph and added a description (update: 774454d0..2993392a4).
akinomyoga
force-pushed
the
REPLY
branch
2 times, most recently
from
774454d to
7da251f
Compare
This was referenced Dec 24, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
#537 (comment)