Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

API (urgent): Rename BashCompDirectives to ShellCompDirectives #1082

Merged
merged 1 commit into from Apr 6, 2020

Conversation

marckhouzam
Copy link
Collaborator

Rename BashCompDirectives to ShellCompDirectives

When answering questions in #1070 about Zsh completion, I realized that the naming for the Completion Directives could be improved. Since those completion directives will be used for different shells, and that these names will be consumed by users, it is more appropriate not to include bash in the name.

If this is worth doing, it should be done right away before the old names get locked as a released API. Assuming it is still ok to make this change.

@jharshman what do you think?

Since the completion directives will be used for all shells, and that
these names will be consumed by users, this is a more appropriate name.

Signed-off-by: Marc Khouzam <marc.khouzam@montreal.ca>
@jharshman jharshman added kind/feature A feature request for cobra; new or enhanced behavior area/shell-completion All shell completions and removed kind/feature A feature request for cobra; new or enhanced behavior labels Apr 6, 2020
Copy link
Collaborator

@jpmcb jpmcb left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, I think this is a great idea. I had noticed when reviewing this PR #1048 that a few locations for fish completions used Bash... which was somewhat confusing.

I think having agnostic naming would be beneficial.

+lgtm

@jharshman jharshman merged commit b84ef40 into spf13:master Apr 6, 2020
@marckhouzam marckhouzam deleted the fix/namingCompDirective branch April 6, 2020 17:54
@marckhouzam
Copy link
Collaborator Author

marckhouzam commented Apr 6, 2020

Thank you @jharshman !

@marckhouzam marckhouzam mentioned this pull request Apr 6, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/shell-completion All shell completions
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants