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

fly: improve help text for fly order-pipelines #4760

Closed
zoetian opened this issue Nov 14, 2019 · 0 comments
Closed

fly: improve help text for fly order-pipelines #4760

zoetian opened this issue Nov 14, 2019 · 0 comments

Comments

@zoetian
Copy link
Member

zoetian commented Nov 14, 2019

What challenge are you facing?

The help text for fly order-pipelines:

Usage:
  fly [OPTIONS] order-pipelines [order-pipelines-OPTIONS]

Application Options:
  -t, --target=              Concourse target name
  -v, --version              Print the version of Fly and exit
      --verbose              Print API requests and responses
      --print-table-headers  Print table headers even for redirected output

Help Options:
  -h, --help                 Show this help message

[order-pipelines command options]
      -p, --pipeline=        Name of pipeline to order

describes the -p flag as Name of pipeline to order, which really makes it seem like you're only supposed to pass this flag once. In fact, if you look at the docs, you see it can be passed multiple times. It would be great if I could learn this from the help text, rather than needing to refer to the docs site.

What would make this better?

Something as simple as

[order-pipelines command options]
      -p, --pipeline=        Name of pipeline to order - this flag can be passed multiple times

The copy could probably be better than that example, but you get the idea.

Are you interested in implementing this yourself?

👍

iamjarvo pushed a commit to iamjarvo/concourse that referenced this issue Nov 15, 2019
iamjarvo added a commit to iamjarvo/concourse that referenced this issue Nov 15, 2019
iamjarvo added a commit to iamjarvo/concourse that referenced this issue Nov 15, 2019
Fixes concourse#4760

Signed-off-by: Jearvon Dharrie <jearvon_dharrie@cable.comast.com>
taylorsilva referenced this issue Jun 1, 2021
Log team name on atc/api
Test instance vars flag
Make missing pipeline error more friendly on fly
Update help text
Fixing migration order

Signed-off-by: Aidan Oldershaw <aoldershaw@pivotal.io>
Co-authored-by: Esteban Foronda <eforonda@vmware.com>
Signed-off-by: Aidan Oldershaw <aoldershaw@pivotal.io>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants