@fdncred I was looking into the outputs of some help commands. And I noticed that sometimes the explanation of a command (aka `usage`) finishes by a dot, and sometimes it doesn't:
@fdncred I was looking into the outputs of some help commands. And I noticed that sometimes the explanation of a command (aka `usage`) finishes by a dot, and sometimes it doesn't:


Same thing applies for `extra_usage`.
Also, there is an inconsistency with the arguments' description of some commands (below the command http get), some descriptions begin by a capital, where others don't:

I compared those outputs with ones from `curl` and `wget`, and they finish their sentence with a dot (which seems completely fine).

So, I would recommend the following things:
- `usage`: begin by a capital and end with a dot
- `extra_usage`: begin by a capital and end with a dot
- Argument `desc`: begin by a capital and do not end with a dot
Now, the last remaining thing: should we apply the same rules to the description of the examples? Should we begin those descriptions by a capital and prevent the ending with a dot?
I'm completely opened to any suggestion here, and I would be happy to work on this uniformization. But, how could we prevent those deviations in the future? To prevent to do the same work multiples times in the future, and to reduce the PR review cumbersome on this part.
_Originalmente postado por @jaudiger em https://github.com/nushell/nushell/issues/5066#issuecomment-1421528910_
0 条评论