cli.py: Complete docstrings
authorBrian Dolbec <dolsen@gentoo.org>
Thu, 15 May 2014 17:13:24 +0000 (10:13 -0700)
committerBrian Dolbec <dolsen@gentoo.org>
Thu, 15 May 2014 17:13:24 +0000 (10:13 -0700)
gkeyldap/cli.py

index 1eba84104239d9d34ec57bf4f300c9c32ef454fc..51a5060a2fade0ba7885db10243e41eab1cbc66f 100644 (file)
@@ -27,6 +27,8 @@ class Main(object):
         """ Main class init function.
 
         @param root: string, root path to use
+        @param config: optional GKeysConfig instance, For API use
+        @param print_results: optional boolean, for API use
         """
         self.root = root or "/"
         self.config = config or GKeysConfig(root=root)
@@ -36,6 +38,11 @@ class Main(object):
 
 
     def __call__(self, args=None):
+        """Main class call function
+
+        @param args: Optional list of argumanets to parse and action to run
+                     Defaults to sys.argv[1:]
+        """
         if args:
             self.run(self.parse_args(args))
         else: