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

Add completions for Mariner #5718

Merged
merged 2 commits into from Mar 3, 2019
Merged

Add completions for Mariner #5718

merged 2 commits into from Mar 3, 2019

Conversation

radek-sprta
Copy link
Contributor

Description

Add completions for Mariner.

Fixes issue #

TODOs:

  • User-visible changes noted in CHANGELOG.md

Copy link
Member

@faho faho left a comment

Choose a reason for hiding this comment

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

Remove trailing "." from descriptions, use less quoting.

Otherwise this looks nice!


# Global options
complete -f -n "__fish_use_subcommand $subcommands" -c mariner -l 'version' --description "Show program's version number and exit"
complete -f -n "__fish_use_subcommand $subcommands" -c mariner -s 'v' -l 'verbose' --description "Increase verbosity of output. Can be repeated."
Copy link
Member

Choose a reason for hiding this comment

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

Not all arguments need to be quoted. And while you shouldn't always check if something has to be quoted or not, if it's one simple word it shouldn't be - -s v -l verbose is nicer to look at, and saves 4 characters which makes the line a bit shorter.

Also the description should not end in a period (space is at a premium for descriptions because every character less makes it more likely that you can fit more columns).

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I have a habit to quote all strings, so syntax checker picks them up :]. I've removed them sin the following commit.
Good observation on the periods! I should remove them from Mariner itself as well.

set -l subcommands complete config details download help magnet open search

# Subcommands
complete -f -n "__fish_use_subcommand $subcommands" -c mariner -a 'complete' --description "Print bash completion command (cliff)"
Copy link
Member

Choose a reason for hiding this comment

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

What does that "cliff" mean here?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

It's just a comment that comes from the underlying CLI framework. I've removed it.

@faho faho added this to the fish 3.1.0 milestone Mar 3, 2019
@faho faho merged commit 261d483 into fish-shell:master Mar 3, 2019
@faho
Copy link
Member

faho commented Mar 3, 2019

Merged, thanks!

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Apr 16, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants