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.

Sign up for GitHub

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

Jump to bottom

[Tiny] Update command doc comments to avoid completions bug #772

Merged
merged 1 commit into from
Jun 18, 2020
Merged

[Tiny] Update command doc comments to avoid completions bug #772

merged 1 commit into from
Jun 18, 2020

Conversation

charlespierce
Copy link
Contributor

Closes #770
Closes #496

Info

  • StructOpt / Clap seem to generate invalid completions files for zsh when there is a : in the description for a command or flag.
  • This results in very weird behavior when pressing Tab while using the auto-generated completions.

Changes

  • Removed the : from the volta list description, replacing it with a -

Tested

  • Confirmed locally that completions no longer error.

@charlespierce charlespierce mentioned this pull request Jun 18, 2020
Closed
mikrostew
mikrostew approved these changes Jun 18, 2020
View reviewed changes
Copy link
Contributor

@mikrostew mikrostew left a comment

Choose a reason for hiding this comment

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

LGTM!

@charlespierce charlespierce merged commit 884113f into volta-cli:main Jun 18, 2020
@charlespierce charlespierce deleted the zsh_completions branch June 18, 2020 21:42
@nicholastmosher nicholastmosher mentioned this pull request Nov 17, 2020
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@mikrostew mikrostew mikrostew approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Completion for volta list is broken in Zsh Completions for zsh is not working
2 participants
@charlespierce @mikrostew