<div dir="ltr"><div>H there,</div><div><br></div><div>I just went through a few branches and noticed that we're still slightly mixed up on the conventions for command help.<br></div><div><br></div><div>Since we're just doing the migration from the "snappy" command into "snap", this is a good time for us to get a more consolidated view on that.</div><div><br></div><div>Here is a proposal, taking the assert command as an example.</div><div><br></div><div>- Short help: starts with a verb, inline, no punctuation:</div><div><br></div><div>var shortAssertHelp = i18n.G("Adds an assertion to the system.")</div><div><br></div><div>- Long help: starts with "The <name> command", backquoted broken out lines, proper punctuation:</div><div><br></div><div>var longAssertHelp = i18n.G(`<br></div><div>The assert command attempts to add the assertion in the provided file<br></div><div>to the system assertion database. (...)</div><div>`)</div><div><br></div><div>The longAssertHelp will likely have to be stripped out of its leading newline, but I suggest we keep the format like that, both to make reading the likely display result easier, and to encourage slightly more descriptive user-oriented comments on our commands.</div><div><br></div><div>Sounds reasonable?</div><div><br></div><div><div><br></div><div class="gmail_signature">gustavo @ <a href="http://niemeyer.net" target="_blank">http://niemeyer.net</a></div>
</div></div>