diff options
author | Jon Bernard <jbernard@tuxion.com> | 2011-07-03 09:22:01 -0400 |
---|---|---|
committer | Jon Bernard <jbernard@tuxion.com> | 2011-07-03 09:22:01 -0400 |
commit | 2b5cb6b1ede6dd4ff4abada0845241145cbbe97e (patch) | |
tree | 845f7d5e83686bf03171a655f10086b267fc66ed | |
parent | 1f7dcb2cedf4d46547fbd71c970b98252bb32b95 (diff) | |
download | dotfiles-2b5cb6b1ede6dd4ff4abada0845241145cbbe97e.tar.gz dotfiles-2b5cb6b1ede6dd4ff4abada0845241145cbbe97e.tar.bz2 dotfiles-2b5cb6b1ede6dd4ff4abada0845241145cbbe97e.zip |
Add a bit of documentation to the top-level modules
-rw-r--r-- | dotfiles/cli.py | 7 | ||||
-rw-r--r-- | dotfiles/core.py | 7 |
2 files changed, 14 insertions, 0 deletions
diff --git a/dotfiles/cli.py b/dotfiles/cli.py index fda0a2e..1e2437f 100644 --- a/dotfiles/cli.py +++ b/dotfiles/cli.py @@ -1,10 +1,17 @@ # -*- coding: utf-8 -*- +""" +dotfiles.cli + +This module provides the CLI interface to dotfiles. +""" + import os from . import core import ConfigParser from optparse import OptionParser, OptionGroup + USAGE = "Usage: %prog ACTION [OPTION...] [FILE...]" NO_REPO_MESSAGE = """Could not find dotfiles repository \"%s\" diff --git a/dotfiles/core.py b/dotfiles/core.py index 843f90f..58310d2 100644 --- a/dotfiles/core.py +++ b/dotfiles/core.py @@ -1,5 +1,12 @@ # -*- coding: utf-8 -*- +""" +dotfiles.core +~~~~~~~~~~~~~ + +This module provides the basic functionality of dotfiles. +""" + import os import shutil |