HomePhorge

(#7764, 7775, 7778) Revisions to Faces help text
17723634875eUnpublished

Unpublished Commit ยท Learn More

Repository Importing: This repository is still importing.

Description

(#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.

Details

Provenance
nfagerlund <nick.fagerlund@gmail.com>Authored on
vanmeeuwenPushed on Jun 2 2015, 2:22 PM
Parents
rPU5a9998e41bc4: (#7773, 7776, 7764) Several help template tweaks
Branches
Unknown
Tags
Unknown

Event Timeline

nfagerlund <nick.fagerlund@gmail.com> committed rPU17723634875e: (#7764, 7775, 7778) Revisions to Faces help text (authored by nfagerlund <nick.fagerlund@gmail.com>).Jun 7 2011, 11:08 PM