bash-completion
bash-completion copied to clipboard
docs: add API and naming
- https://github.com/scop/bash-completion/discussions/537
- https://github.com/scop/bash-completion/discussions/539
I think the descriptions of the existing rules are fine. In addition, I have questions about the naming rules for the following cases (I have created separate threads in #539):
- More flexible positions of double underscores in the names? -> #539 (thread)
- Naming of local variables in the function that exports variables of dynamic names? -> #539 (thread)
https://github.com/scop/bash-completion/discussions/539#discussioncomment-3541381
I think we have a conclusion here and in https://github.com/scop/bash-completion/pull/791. Could you document the convention in https://github.com/scop/bash-completion/pull/731? TIA :)
I'm not sure if I correctly get your intent, but I added a commit 4f6e4241865ffdbc7789df214173348452643701 that describes the rule of _mut_
.
I also suggest using the word "private" instead of "internal" for the symmetry with "public" in the counterpart (see commit 5435b7ce49f1be7290e9e1fe9b6097363d78b4fa), though I am not sure if you like it. If not, we can drop this commit any time.
Both 4f6e424 and 5435b7c look good to me, thanks!
Thanks for checking!
I wonder if we have some unfinished business here still, or should we proceed to merge?
I think we can merge it. Maybe there would be something to adjust after the refactoring, but I think that can be always processed in another PR.
By the way, I think it is good to include links to these documents in CONTRIBUTING.md
Link to CONTRIBUTING.md added, cheers.
Thanks!