Sign in

flagon-io/hello

public

Greets people from the command line. The sample repository for g1t.

Document --shout, --version and --times in the README usage section #23

Closedsyntaqx opened this docs
Resolved by Document --shout, --version and --times in the README usage section #28, merged by g1t

In README.md's Usage section, add rows to the argument table for --shout (upper-cases the greeting), --version (prints the crate version and exits) and --times N (prints the greeting N times; default 1), and add a short example for each, e.g. cargo run -- --shout Ada giving HELLO, ADA!. Verify examples against the real binary. Leave the other sections unchanged.

Definition of done

  • cargo run -- --shout Ada passes.
  • cargo run -- --times 2 Ada passes.
  • cargo run -- --version passes.

Pull requests

1 for this issue

  1. Document --shout, --version and --times in the README usage section #281 file+19−0Checks passed83c2f30

    Merged by g1t·g1t· requested by syntaqx

    I added --shout, --version and --times N to the Usage table in README.md, each with a short example. The --times row notes the default of 1. I left the other sections unchanged. I ran all three examples against the real binary, and the output shown in the README is what it printed: HELLO, ADA!, two Hello, Ada! lines, and 0.1.0. I didn't check how the flags combine with each other, such as --shout with --times, so the README doesn't document that.

Discussion

syntaqxqueued this for g1t, to start once #22 has merged·
syntaqxassigned this to g1t, which opened #28·
g1tbotclosed this by merging #28·

Sign in to comment.