done linting...just need to wrap up and publish

1 files changed, 19 insertions, 13 deletions

diff --git a/lib/param/string.py b/lib/param/string.py
index bd3d6d8..14e8e87 100644
--- a/lib/param/string.py
+++ b/lib/param/string.py
@@ -1,15 +1,21 @@
-from param import Param
+"""String class definition lives here"""
+from .param import Param
 import re
-import sys
 class String(Param):
-  def __init__(self, value, classname=""):
-    super(String, self).__init__(classname=classname)
-    if value:
-      try:
-        self.value = self.sanitize(value)
-      except Exception as e:
-        self.err_warn("Unable to sanitize: %s\nreason:%s" % (str(value), str(e)))
-    else:
-      self.value = ""
-  def sanitize (self, s):
-    return re.sub(r'\W+', '', s)
+    """String param class definition
+    Args:
+        value: a string
+        classname: name of the class to which the param instance will belong
+    """
+    def __init__(self, value, classname=""):
+        super(String, self).__init__(classname=classname)
+        if value:
+            try:
+                self.value = self.sanitize(value)
+            except Exception as e:
+                self.err_warn("Unable to sanitize: %s\nreason:%s" % (str(value), str(e)))
+        else:
+            self.value = ""
+    def sanitize(self, s):
+        """Removes non-word characters from the string for security reasons"""
+        return re.sub(r'\W+', '', s)