bash-completion icon indicating copy to clipboard operation
bash-completion copied to clipboard

docs: add API and naming

Open scop opened this issue 2 years ago • 4 comments

  • https://github.com/scop/bash-completion/discussions/537
  • https://github.com/scop/bash-completion/discussions/539

scop avatar Apr 11 '22 07:04 scop

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)

akinomyoga avatar Apr 12 '22 14:04 akinomyoga

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.

akinomyoga avatar Sep 04 '22 00:09 akinomyoga

Both 4f6e424 and 5435b7c look good to me, thanks!

scop avatar Sep 10 '22 20:09 scop

Thanks for checking!

akinomyoga avatar Sep 10 '22 21:09 akinomyoga

I wonder if we have some unfinished business here still, or should we proceed to merge?

scop avatar Dec 06 '22 18:12 scop

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

akinomyoga avatar Dec 06 '22 19:12 akinomyoga

Link to CONTRIBUTING.md added, cheers.

scop avatar Dec 06 '22 19:12 scop

Thanks!

akinomyoga avatar Dec 06 '22 19:12 akinomyoga