Skip to content

Commit

Permalink
Use imperative phrasing for command summaries
Browse files Browse the repository at this point in the history
This makes everything consistent with the version command's:

  Print the runtime version and exit.

And follows the practice recommended by Python's PEP 257 [1]:

  The docstring is a phrase ending in a period. It prescribes the
  function or method's effect as a command ("Do this", "Return that"),
  not as a description; e.g. don't write "Returns the pathname ...".

[1]: https://www.python.org/dev/peps/pep-0257/#one-line-docstrings

Signed-off-by: W. Trevor King <wking@tremily.us>
Reviewed-by: Mike Brown <brownwm@us.ibm.com>
  • Loading branch information
wking committed Dec 9, 2015
1 parent b922732 commit 839b6ee
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion runtime.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ $ echo $?

### start

Starts a container from a bundle directory.
Start a container from a bundle directory.
It operates by default on the `config.json` and `runtime.json` in the current directory.

* *Options*
Expand Down

0 comments on commit 839b6ee

Please sign in to comment.