canonical / canonical/multipass

Imprecision in `multipass help find` message

Open
#580 4 comments 0 reactions 0 assignees View on GitHub
documentation
Dominant language
C++
Stars
9.2k
Forks
828
Avg merge
3d 1h
Merged PRs (30d)
44

Description

```
$ multipass help find
Usage: multipass find [options] [][]
Lists available images matching for creating instances from.
With no search string, lists all aliases for supported Ubuntu releases.

Options:
-h, --help Display this help
-v, --verbose Increase logging verbosity, repeat up to three times for more
detail

Arguments:
string An optional value to search for in [] format,
where can be either ‘release’ or ‘daily’. If
is omitted, it will search ‘release‘ first, and if no matches
are found, it will then search ‘daily‘. can be a
partial image hash or an Ubuntu release version, codename or
alias.
```

`multipass find snapcraft:` is a valid command, so the help message for the argument should not limit remotes to `release` and `daily`. Perhaps adding `snapcraft` to the message is enough for now.

Additionally, there should be brackets around `` in `[]` (as is already the case in the "usage" message.

Contributor guide

Open the contributing guide

Research direction

Locate the help text produced by `multipass help find` and compare it with the issue's captured output. Update the remote description to include `snapcraft` and show brackets around ``; verify the corrected wording by running `multipass help find`.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp
Domain
cli
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.