From 512911a7ccd0a51a4d30d2b693b1e3b25f8acddf Mon Sep 17 00:00:00 2001 From: Ryan Petrello Date: Wed, 1 May 2013 12:20:44 -0400 Subject: [PATCH] Add a docstring. --- pecan/commands/base.py | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/pecan/commands/base.py b/pecan/commands/base.py index 43c25a4..e076b39 100644 --- a/pecan/commands/base.py +++ b/pecan/commands/base.py @@ -108,6 +108,12 @@ class BaseCommandMeta(type): @property def summary(cls): + """ + This is used to populate the --help argument on the command line. + + This provides a default behavior which takes the first sentence of the + command's docstring and uses it. + """ return cls.__doc__.strip().splitlines()[0].rstrip('.')