From 2b5cb6b1ede6dd4ff4abada0845241145cbbe97e Mon Sep 17 00:00:00 2001 From: Jon Bernard Date: Sun, 3 Jul 2011 09:22:01 -0400 Subject: Add a bit of documentation to the top-level modules --- dotfiles/cli.py | 7 +++++++ dotfiles/core.py | 7 +++++++ 2 files changed, 14 insertions(+) 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 -- cgit v1.2.3