Plugins/CheckerPlugins/Tabnanny/Tabnanny.py

changeset 3591
2f2a4a76dd22
parent 3515
1b8381afe38f
child 3670
f0cb7579c0b4
--- a/Plugins/CheckerPlugins/Tabnanny/Tabnanny.py	Sat May 17 19:58:49 2014 +0200
+++ b/Plugins/CheckerPlugins/Tabnanny/Tabnanny.py	Sun May 18 14:13:09 2014 +0200
@@ -83,7 +83,7 @@
         
     def get_lineno(self):
         """
-        Method to retrieve the line number.
+        Public method to retrieve the line number.
         
         @return The line number (integer)
         """
@@ -91,7 +91,7 @@
         
     def get_msg(self):
         """
-        Method to retrieve the message.
+        Public method to retrieve the message.
         
         @return The error message (string)
         """
@@ -99,7 +99,7 @@
         
     def get_line(self):
         """
-        Method to retrieve the offending line.
+        Public method to retrieve the offending line.
         
         @return The line of code (string)
         """
@@ -204,7 +204,8 @@
     # preceding a tab)
     def longest_run_of_spaces(self):
         """
-        Method to calculate the length of longest contiguous run of spaces.
+        Public method to calculate the length of longest contiguous run of
+        spaces.
         
         @return The length of longest contiguous run of spaces (whether or not
             preceding a tab)
@@ -214,7 +215,7 @@
 
     def indent_level(self, tabsize):
         """
-        Method to determine the indentation level.
+        Public method to determine the indentation level.
         
         @param tabsize The length of a tab stop. (integer)
         @return indentation level (integer)
@@ -243,8 +244,8 @@
     # for all t >= 1
     def equal(self, other):
         """
-        Method to compare the indentation levels of two Whitespace objects for
-        equality.
+        Public method to compare the indentation levels of two Whitespace
+        objects for equality.
         
         @param other Whitespace object to compare against.
         @return True, if we compare equal against the other Whitespace object.
@@ -257,7 +258,7 @@
     # case it will return at least one witnessing tab size.
     def not_equal_witness(self, other):
         """
-        Method to calculate a tuple of witnessing tab size.
+        Public method to calculate a tuple of witnessing tab size.
         
         Intended to be used after not self.equal(other) is known, in which
         case it will return at least one witnessing tab size.
@@ -291,8 +292,8 @@
     # Note that M is of the form (T*)(S*) iff len(M.norm[0]) <= 1.
     def less(self, other):
         """
-        Method to compare the indentation level against another Whitespace
-        objects to be smaller.
+        Public method to compare the indentation level against another
+        Whitespace objects to be smaller.
         
         @param other Whitespace object to compare against.
         @return True, if we compare less against the other Whitespace object.
@@ -315,7 +316,7 @@
     # case it will return at least one witnessing tab size.
     def not_less_witness(self, other):
         """
-        Method to calculate a tuple of witnessing tab size.
+        Public method to calculate a tuple of witnessing tab size.
         
         Intended to be used after not self.less(other is known, in which
         case it will return at least one witnessing tab size.

eric ide

mercurial