search

wking / oci-command-line-api

A command-line API specification for opencontainers/specs
Apache License 2.0
2 stars 3 forks source link

Use imperative phrasing for command summaries #7

Closed wking closed 8 years ago

wking commented 8 years ago

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:

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 ...".

mikebrow commented 8 years ago

Reviewed. Looks good to me.

wking commented 8 years ago

On Mon, Dec 07, 2015 at 07:20:44AM -0800, Mike Brown wrote:

Reviewed. Looks good to me.

Rebased onto master after #3, with 963cfe5 → bc9dea8. I'll assume that this LGTM rolls over, since the new diff is just a subset of the original diff. The two-workday window on this one wraps up tonight, so I'll merge it then (assuming nobody speaks up with concerns in the meantime).

wking commented 8 years ago

On Mon, Dec 07, 2015 at 07:20:44AM -0800, Mike Brown wrote:

Reviewed. Looks good to me.

Merged in 839b6ee (GitHub thinks it was bc9dea8 1, but I'd forgotten to add Mike's Reviewed-by).