diff options
author | Jon Bernard <jbernard@tuxion.com> | 2016-04-16 07:49:19 -0400 |
---|---|---|
committer | Jon Bernard <jbernard@tuxion.com> | 2016-04-16 07:49:19 -0400 |
commit | 556d4651252de3ba3884d2a0f3f3522f92e304d9 (patch) | |
tree | 1a755100e658d8cafd569668c1dad6118c5ab29c | |
parent | e3ebfa302efb9234a86e1f25efdc8acc0e21f01d (diff) | |
download | dotfiles-556d4651252de3ba3884d2a0f3f3522f92e304d9.tar.gz dotfiles-556d4651252de3ba3884d2a0f3f3522f92e304d9.tar.bz2 dotfiles-556d4651252de3ba3884d2a0f3f3522f92e304d9.zip |
Add docstring for Config class
-rw-r--r-- | dotfiles/cli.py | 12 |
1 files changed, 12 insertions, 0 deletions
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({}) |