Convention for command help

[Gustavo Niemeyer]

On Wed, Feb 3, 2016 at 3:20 PM, Gustavo Niemeyer <
gustavo.niemeyer at canonical.com> wrote:
>
> var shortAssertHelp = i18n.G("Adds an assertion to the system.")
>

As John pointed out, the punctuation at the end should be dropped. So,
again for clarity, and also adding a note about the use of multiple
paragraphs in the long help text.

- Short help: starts with a verb, inline, no punctuation:

var shortAssertHelp = i18n.G("Adds an assertion to the system")

- Long help: starts with "The <name> command", backquoted broken out lines,
proper punctuation, okay to use multiple paragraphs to help readability:

var longAssertHelp = i18n.G(`
The assert command attempts to add the assertion in the provided file
to the system assertion database. (...)

Some more text if necessary (...)
`)


gustavo @ http://niemeyer.net
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <https://lists.ubuntu.com/archives/snappy-devel/attachments/20160203/ff18e6d8/attachment.html>