stackforge/pecan
Code Issues Proposed changes

Add a docstring.

Browse Source
This commit is contained in:
Ryan Petrello
2013-05-01 12:20:44 -04:00
parent 883d3e90f9
commit 512911a7cc
1 changed files with 6 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
pecan/commands/base.py
View File

@@ -108,6 +108,12 @@ class BaseCommandMeta(type):
@property @property
def summary(cls): 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('.') return cls.__doc__.strip().splitlines()[0].rstrip('.')