Added a few more check patterns to the eric summary doc style checker.

Sat, 17 May 2014 19:58:49 +0200

author
Detlev Offenbach <detlev@die-offenbachs.de>
date
Sat, 17 May 2014 19:58:49 +0200
changeset 3590
5280e37405b8
parent 3589
48aded8560dc
child 3591
2f2a4a76dd22

Added a few more check patterns to the eric summary doc style checker.

Plugins/CheckerPlugins/CodeStyleChecker/DocStyleChecker.py file | annotate | diff | comparison | revisions
--- a/Plugins/CheckerPlugins/CodeStyleChecker/DocStyleChecker.py	Sat May 17 18:53:04 2014 +0200
+++ b/Plugins/CheckerPlugins/CodeStyleChecker/DocStyleChecker.py	Sat May 17 19:58:49 2014 +0200
@@ -1228,22 +1228,31 @@
         if summary:
             # check, if the first word is 'Constructor', 'Public',
             # 'Protected' or 'Private'
-            functionName = context.source()[0].lstrip().split()[1]\
-                .split("(")[0]
+            functionName, arguments = context.source()[0].lstrip()\
+                .split()[1].split("(", 1)
             firstWord = summary.strip().split(None, 1)[0].lower()
             if functionName == '__init__':
                 if firstWord != 'constructor':
                     self.__error(docstringContext.start() + lineNumber, 0,
                                  "D232", 'constructor')
+            elif functionName.startswith('__') and \
+                    functionName.endswith('__'):
+                if firstWord != 'special':
+                    self.__error(docstringContext.start() + lineNumber, 0,
+                                 "D232", 'special')
             elif functionName.startswith(('__', 'on_')):
                 if firstWord != 'private':
                     self.__error(docstringContext.start() + lineNumber, 0,
                                  "D232", 'private')
             elif functionName.startswith('_') or \
-                functionName.endswith('Event'):
+                    functionName.endswith('Event'):
                 if firstWord != 'protected':
                     self.__error(docstringContext.start() + lineNumber, 0,
-                             "D232", 'protected')
+                                 "D232", 'protected')
+            elif arguments.startswith(('cls,', 'cls)')):
+                if firstWord != 'class':
+                    self.__error(docstringContext.start() + lineNumber, 0,
+                                 "D232", 'class')
             else:
                 if firstWord != 'public':
                     self.__error(docstringContext.start() + lineNumber, 0,

eric ide

mercurial