diff options
| author | Nicolas Chauvat <nicolas.chauvat@logilab.fr> | 2008-07-13 21:32:22 +0200 |
|---|---|---|
| committer | Nicolas Chauvat <nicolas.chauvat@logilab.fr> | 2008-07-13 21:32:22 +0200 |
| commit | aab929e273a41a188a244b5d2c8b3e53408172ab (patch) | |
| tree | bdbb169569082a3290de6dbdaf7ef7d68bc919c1 /clcommands.py | |
| parent | 47df8cd6dff5c08b32966a7b59b5da75d23123de (diff) | |
| download | logilab-common-aab929e273a41a188a244b5d2c8b3e53408172ab.tar.gz | |
improve doc for better epydoc generation.
Diffstat (limited to 'clcommands.py')
| -rw-r--r-- | clcommands.py | 28 |
1 files changed, 9 insertions, 19 deletions
diff --git a/clcommands.py b/clcommands.py index 57ea325..e68fa7f 100644 --- a/clcommands.py +++ b/clcommands.py @@ -1,24 +1,14 @@ -# This program is free software; you can redistribute it and/or modify it under -# the terms of the GNU General Public License as published by the Free Software -# Foundation; either version 2 of the License, or (at your option) any later -# version. -# -# This program is distributed in the hope that it will be useful, but WITHOUT -# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS -# FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. -# -# You should have received a copy of the GNU General Public License along with -# this program; if not, write to the Free Software Foundation, Inc., -# 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. -"""provides helper functions to handle a command line tool providing more than -one command +"""Helper functions to support command line tools providing more than +one command. + e.g called as "tool command [options] args..." where <options> and <args> are command'specific -:author: Logilab -:copyright: 2003-2008 LOGILAB S.A. (Paris, FRANCE) -:contact: http://www.logilab.fr/ -- mailto:python-projects@logilab.org +:copyright: 2003-2008 LOGILAB S.A. (Paris, FRANCE), all rights reserved. +:contact: http://www.logilab.fr/ -- mailto:contact@logilab.fr +:license: General Public License version 2 - http://www.gnu.org/licenses """ +__docformat__ = "restructuredtext en" # XXX : merge with optparser ? import sys @@ -38,12 +28,12 @@ command. Available commands are :\n''' class BadCommandUsage(Exception): """Raised when an unknown command is used or when a command is not - correctly used + correctly used. """ class Command(Configuration): - """base class for command line commands""" + """Base class for command line commands.""" arguments = '' name = '' # hidden from help ? |