Mercurial Repositories > Radon Code Metrics / file diff

--- a/RadonMetrics/MaintainabilityIndexCalculator.py	Sat Sep 19 11:54:33 2015 +0200
+++ b/RadonMetrics/MaintainabilityIndexCalculator.py	Sat Sep 19 18:24:07 2015 +0200
@@ -3,10 +3,14 @@
 # Copyright (c) 2015 Detlev Offenbach <detlev@die-offenbachs.de>
 #
 
+"""
+Module implementing the maintainability index service.
+"""
+
 from __future__ import unicode_literals
 
 try:
-    str = unicode       # __IGNORE_EXCEPTION __IGNORE_WARNING__
+    str = unicode       # __IGNORE_EXCEPTION__ __IGNORE_WARNING__
 except NameError:
     pass
 
@@ -39,7 +43,7 @@
     @param file source filename
     @type str
     @param text source text
-    @param str
+    @type str
     @return tuple containing the result dictionary
     @rtype (tuple of dict)
     """
@@ -51,7 +55,8 @@
     Module function to calculate the maintainability index for a batch of
     files.
     
-    @param argumentsList list of arguments tuples as given for check
+    @param argumentsList list of arguments tuples as given for
+        maintainabilityIndex
     @type list
     @param send reference to send function
     @type function
@@ -99,7 +104,8 @@
 
 def worker(input, output):
     """
-    Module function acting as the parallel worker for the style check.
+    Module function acting as the parallel worker for the maintainability
+    index calculation.
     
     @param input input queue
     @type multiprocessing.Queue