add more docstrings
[logparse.git] / logparse / config.py
index 8d1b21eb2065e1fe5bcedbb073c7c37bb3ebf9a0..df81c4e60448e36e289f507809cdd2d0c61bd609 100644 (file)
@@ -1,14 +1,15 @@
-#
-#   config.py
-#
-#   Default config values and basic wrapper for ConfigParser. New config options
-#   should be added to the dictionary below, along with appropriate defaults.
-#
-#   Runtime configuration is done through /etc/logparse/logparse.conf (default)
-#   or the path specified in the "--config" argument. The file uses the INI
-#   syntax, with general options being declared in the [logparse] section and
-#   parser-specific options declared in their own sections.
-#
+"""
+This modules contains default config values and basic wrapper for ConfigParser.
+New config options should be added to the dictionary below, along with 
+appropriate defaults. Runtime configuration is done through the config file at
+/etc/logparse/logparse.conf (default) or the path specified in the "--config"
+argument. The file uses the INI syntax, with general options being declared in
+the [logparse] section and parser-specific options declared in their own
+sections.
+
+This module provides the following methods:
+    - `loadconf()`: set up ConfigParser and process config file
+"""
 
 from configparser import ConfigParser
 from pkg_resources import Requirement, resource_filename
@@ -87,15 +88,6 @@ defaults = {
         }
 }
 
-def locate(filename):
-    """
-    DEPRECATED: draft method for what is now parsers/load_parsers.py. Kept here
-    for historical purposes.
-    """
-    logger.debug("Searching for {0}".format(filename))
-    loc = resource_filename(Requirement.parse(__package__), filename)
-    logger.debug("Found {0}".format(loc))
-    return loc
 
 def loadconf(configpaths):
     """