Inconsistencies in punctuation of flag description

[rkpattnaik780]

Current scenario

There are some inconsistencies regarding use of periods in flag descriptions. Some flags end with period and some don't. As suggested by @craicoverflow we shouldn't use periods as the flags provided by cobra (--default and --help) don't use them too.

Proposal

Remove full stops from description of all flags.

[rkpattnaik780]

@bhardesty what's your take on this issue?

[ankithans]

can be tackled through Charmil validator in future! Can add a rule for this.
cc: @wtrocki

[rkpattnaik780]

can be tackled through Charmil validator in future! Can add a rule for this.

Thanks @ankithans :). That will be great.

[wtrocki]

Great idea. We need to fix multiple commands that have missing descriptions etc. See #777

[bhardesty]

We should try to be consistent. However, some flag descriptions have multiple sentences, so they should end with a full stop.

How do the "default" and "choose from" values work? I think they're generated by cobra and appended to the end of the flag description. Can you control the punctuation? Here's an example of a description with both:

-o, --output string
  Format in which to display the Kafka instance. Choose from: "json", "yml", "yaml" (default "json")

I'll raise this with the rest of the docs team next time that we meet, and report back with a recommendation.

[rkpattnaik780]

Can you control the punctuation?

Seems the punctuation can be controlled.
Taking a quick look at other CLIs, full stops are not that popular with flags.

[wtrocki]

Checked couple popular clis. Punctuations aren't used for flags for those.

[bhardesty]

To follow up, I think we can remove the periods. There are only a couple descriptions with multiple sentences, and I think they can be revised to just be a single sentence (without a period).