diff options
| author | nfagerlund <nick.fagerlund@gmail.com> | 2011-06-03 10:28:52 -0700 |
|---|---|---|
| committer | nfagerlund <nick.fagerlund@gmail.com> | 2011-06-07 14:08:39 -0700 |
| commit | 17723634875e308b2752efed8ebdfd3db3239215 (patch) | |
| tree | 7875a3832c4b1a9acccb12ba1609da997c8cac1d /examples/code/snippets | |
| parent | 5a9998e41bc442ca66ca2ff151750355d2ef6d6f (diff) | |
| download | puppet-17723634875e308b2752efed8ebdfd3db3239215.tar.gz puppet-17723634875e308b2752efed8ebdfd3db3239215.tar.xz puppet-17723634875e308b2752efed8ebdfd3db3239215.zip | |
(#7764, 7775, 7778) Revisions to Faces help text
Per UX review of help text, this commit makes several changes over the breadth
of the Faces help:
* Preface API-only action summaries/descriptions with "API only." (issue #7775)
* Provide both CLI and API info in "returns," with the CLI info first. (issue #7778)
* Summaries should be sentences. (Add punctuation.)
* First sentences of descriptions should reiterate summaries. (Summaries and
descriptions should be displayed far enough apart that this isn't a problem.)
* Standardize on "subcommand" instead of "face" when talking about the entity
you invoke at the command line. (Use "face" when describing API use.)
* Fix outdated or clunky text in several faces.
Diffstat (limited to 'examples/code/snippets')
0 files changed, 0 insertions, 0 deletions