wrote basic SimpleConfig docstring

2012-11-18 22:29:32 -08:00 · 2012-11-18 22:29:32 -08:00 · c4955ebddd
commit c4955ebddd
parent 86da219fb9
1 changed files with 7 additions and 0 deletions
--- a/lib/simple_config.py
+++ b/lib/simple_config.py
@ -7,7 +7,14 @@ from version import ELECTRUM_VERSION, SEED_VERSION


 class SimpleConfig:
+"""

+The SimpleConfig class is responsible for handling operations involving
+configuration files.  The constructor reads and stores the system and 
+user configurations from electrum.conf into seperate dictionaries within
+a SimpleConfig instance then reads the wallet file.
+
+"""
    def __init__(self, options={}):

        # system conf, readonly