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

doc: more detailed --help #531

Merged
merged 1 commit into from
Nov 18, 2021
Merged

doc: more detailed --help #531

merged 1 commit into from
Nov 18, 2021

Conversation

YikSanChan
Copy link
Member

@YikSanChan YikSanChan commented Nov 18, 2021

Learn from spf13/cobra#571 (comment).

Note the difference in "Usage".

before:

$ featctl describe entity --help
show details of a specific entity

Usage:
  featctl describe entity [flags]

Flags:
  -h, --help   help for entity

Global Flags:
      --config string   config file (default "/Users/chenyisheng/.config/featctl/config.yaml")

after:

$ featctl describe entity --help
show details of a specific entity

Usage:
  featctl describe entity <entity_name> [flags]

Flags:
  -h, --help   help for entity

Global Flags:
      --config string   config file (default "/Users/chenyisheng/.config/featctl/config.yaml")

close #530

@codecov
Copy link

codecov bot commented Nov 18, 2021

Codecov Report

Merging #531 (8271909) into main (6e1cf67) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##             main     #531   +/-   ##
=======================================
  Coverage   57.38%   57.38%           
=======================================
  Files          38       38           
  Lines        1605     1605           
=======================================
  Hits          921      921           
  Misses        552      552           
  Partials      132      132           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 6e1cf67...8271909. Read the comment docs.

Copy link
Member

@wfxr wfxr left a comment

Choose a reason for hiding this comment

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

LGTM

@YikSanChan YikSanChan merged commit ac1343a into main Nov 18, 2021
@YikSanChan YikSanChan deleted the more-detailed-help branch November 18, 2021 08:05
YikSanChan added a commit that referenced this pull request Dec 20, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

More detailed --help message
2 participants