diff options
author | Zearin <zearin@gonk.net> | 2011-10-07 11:08:32 -0400 |
---|---|---|
committer | Zearin <zearin@gonk.net> | 2011-10-07 11:10:28 -0400 |
commit | dcfe07f78c618cd4154cf5745c9c8dfcd3df5ad3 (patch) | |
tree | 98e485a526b62e213e7f08c3f1ad686fc5f039aa | |
parent | a24c0a7f5eb85057baa4e6657a0ca3845a4cfb7e (diff) | |
download | cmd2-dcfe07f78c618cd4154cf5745c9c8dfcd3df5ad3.tar.gz |
Added header comments to describe each file's purpose.
-rw-r--r-- | __init__.py | 14 | ||||
-rw-r--r-- | commands.py | 3 | ||||
-rw-r--r-- | errors.py | 3 | ||||
-rw-r--r-- | parsers.py | 3 | ||||
-rw-r--r-- | support.py | 6 | ||||
-rw-r--r-- | tests.py | 3 |
6 files changed, 32 insertions, 0 deletions
diff --git a/__init__.py b/__init__.py index e69de29..18cedec 100644 --- a/__init__.py +++ b/__init__.py @@ -0,0 +1,14 @@ +# This file’s existence lets Python know that the current directory is a package +# (a directory containing related modules). +# +# “Cmd2. Now with more module™.” +# + + + +# Allow `from cmd2 import *` to be used efficiently if desired. +# +# @see +# http://docs.python.org/tutorial/modules.html#importing-from-a-package +# +__all__ = ['cmd2','commands','errors','support','tests']
\ No newline at end of file diff --git a/commands.py b/commands.py index e69de29..608bc63 100644 --- a/commands.py +++ b/commands.py @@ -0,0 +1,3 @@ +''' +This file should contain all the `do_*` commands built-in to Cmd2. +'''
\ No newline at end of file @@ -0,0 +1,3 @@ +''' +This file should contain define all the Exceptions/Errors in Cmd2. +'''
\ No newline at end of file @@ -0,0 +1,3 @@ +''' +This file should contain all parser definitions for Cmd2. +'''
\ No newline at end of file @@ -0,0 +1,6 @@ +''' +This file should contain all "helper" code for Cmd2. + +This includes things such as hook methods, ParsedString, Stubborndict, Borg, Statekeeper, +History, and so on. +'''
\ No newline at end of file @@ -0,0 +1,3 @@ +''' +This file should contain all tests for Cmd2. +'''
\ No newline at end of file |