Merge pull request #359 from JrGoodle/refactor-kwargs

Refactor kwargs
JrGoodle · Oct 30, 2017 · fd5ebc0 · fd5ebc0
2 parents 8617aab + 9a7d4c4
commit fd5ebc0
Show file tree

Hide file tree

Showing 19 changed files with 646 additions and 308 deletions.
diff --git a/.codeclimate.yml b/.codeclimate.yml
@@ -1,4 +1,13 @@
 version: "2"
+
+engines:
+  pep8:
+    enabled: true
+
+ratings:
+   paths:
+   - "**.py"
+
 checks:
   argument-count:
     config:

diff --git a/.pylintrc b/.pylintrc
@@ -355,7 +355,7 @@ valid-metaclass-classmethod-first-arg=mcs
 [DESIGN]
 
 # Maximum number of arguments for function / method
-max-args=10
+max-args=5
 
 # Maximum number of attributes for a class (see R0902).
 max-attributes=10

diff --git a/clowder/clowder/clowder_controller.py b/clowder/clowder/clowder_controller.py
diff --git a/clowder/clowder/clowder_repo.py b/clowder/clowder/clowder_repo.py
@@ -22,9 +22,21 @@
 
 
 class ClowderRepo(object):
-    """Class encapsulating clowder repo information"""
+    """Class encapsulating clowder repo information
+
+    Attributes:
+        root_directory (str): Root directory of clowder projects
+        default_ref (str): Default ref
+        remote (str): Remote name
+        clowder_path (path): Absolute path to clowder repo
+    """
 
     def __init__(self, root_directory):
+        """ClowderController __init__
+
+        :param str root_directory: Root directory of clowder projects
+        """
+
         self.root_directory = root_directory
         self.default_ref = 'refs/heads/master'
         self.remote = 'origin'