From 556d4651252de3ba3884d2a0f3f3522f92e304d9 Mon Sep 17 00:00:00 2001 From: Jon Bernard Date: Sat, 16 Apr 2016 07:49:19 -0400 Subject: Add docstring for Config class --- dotfiles/cli.py | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/dotfiles/cli.py b/dotfiles/cli.py index 9374bc0..15f5992 100644 --- a/dotfiles/cli.py +++ b/dotfiles/cli.py @@ -21,6 +21,18 @@ CONTEXT_SETTINGS = dict(auto_envvar_prefix='DOTFILES', class Config(object): + """The configuration information for a set of repositories. + + Each repository has its own configuration defined by the contents of a + repository-specific configuration file. If such a file is present, the + fields it defines will be added to any existing global configuration. + + The command line will override all of this. + + And this all needs to be implemented. + + :param paths: a list of repository path locations + """ def __init__(self, paths): self.settings = self.parse_config({}) -- cgit v1.2.3