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

Fix trivial typo in command line help message #188

Closed
wants to merge 1 commit into from

Conversation

mabelzhang
Copy link
Contributor

🦟 Bug fix

Typo in help message.

P.S. There is a correct description in line 68, but I don't know what that description is used for. It doesn't get printed.

Summary

Checklist

  • Signed all commits for DCO
  • Added tests
  • Updated documentation (as needed)
  • Updated migration guide (as needed)
  • codecheck passed (See contributing)
  • All tests passed (See test coverage)
  • While waiting for a review on your PR, please help review another open pull request to support the maintainers

Note to maintainers: Remember to use Squash-Merge

@mabelzhang mabelzhang requested a review from caguero as a code owner October 13, 2021 02:11
@codecov
Copy link

codecov bot commented Oct 13, 2021

Codecov Report

Merging #188 (42e36d0) into main (c9ac4ee) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##             main     #188   +/-   ##
=======================================
  Coverage   84.56%   84.56%           
=======================================
  Files           7        7           
  Lines         855      855           
=======================================
  Hits          723      723           
  Misses        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 c9ac4ee...42e36d0. Read the comment docs.

@chapulina
Copy link
Contributor

P.S. There is a correct description in line 68, but I don't know what that description is used for. It doesn't get printed.

I see both 😵

$ ign msg --help
Print information about ignition messages.

  ign msg [options]

Options:

  -i [ --info ] arg     Get info about the specified message type.
  -l [ --list ]         List all topics.
  -h [ --help ]              Print this help message.
  --force-version <VERSION>  Use a specific library version.
  --versions                 Show the available versions.
    -h "Print this help message,
        --help",
    -l, --list                       Print all message types
    -i, --info msg                   Print information about a message

btw, it would be nice to also fix the uneven indentation

@nkoenig
Copy link
Contributor

nkoenig commented Oct 18, 2021

I'm going to update the PR with an fix for @chapulina comment and re-target to citadel.

@nkoenig nkoenig closed this Oct 18, 2021
@mabelzhang mabelzhang deleted the mabelzhang/cmd_list_typo branch January 22, 2022 06:21
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.

4 participants