Mercurial Repositories > eric / file comparison
comparison: eric6/Plugins/CheckerPlugins/CodeStyleChecker/DocStyle/DocStyleChecker.py
eric6/Plugins/CheckerPlugins/CodeStyleChecker/DocStyle/DocStyleChecker.py
- changeset 7998
- cd41c844862f
- parent 7987
- e8eb8370ea94
- child 8043
- 0acf98cd089a
- child 8166
- bd5cd5858503
equal
deleted
inserted
replaced
| 7997:2ca23396c25c | 7998:cd41c844862f |
|---|---|
| 126 "D111", "D112", | 126 "D111", "D112", |
| 127 "D121", "D122", | 127 "D121", "D122", |
| 128 "D130", "D131", "D132", "D133", "D134", | 128 "D130", "D131", "D132", "D133", "D134", |
| 129 "D141", "D142", "D143", "D144", "D145", | 129 "D141", "D142", "D143", "D144", "D145", |
| 130 | 130 |
| 131 "D203", "D205", "D206", | 131 "D201", "D202.1", "D202.2", "D203", "D205", "D206", |
| 132 "D221", "D222", | 132 "D221", "D222", |
| 133 "D231", "D232", "D234r", "D234y", "D235r", "D235y", "D236", "D237", | 133 "D231", "D232", "D234r", "D234y", "D235r", "D235y", "D236", "D237", |
| 134 "D238", "D239", | 134 "D238", "D239", |
| 135 "D242", "D243", "D244", "D245", "D246", "D247", | 135 "D242", "D243", "D244", "D245", "D246", "D247", |
| 136 "D250", "D251", "D252", "D253", | 136 "D250", "D251", "D252", "D253", |
| 214 ], | 214 ], |
| 215 } | 215 } |
| 216 elif self.__docType == "eric": | 216 elif self.__docType == "eric": |
| 217 checkersWithCodes = { | 217 checkersWithCodes = { |
| 218 "moduleDocstring": [ | 218 "moduleDocstring": [ |
| 219 (self.__checkModulesDocstrings, ("D101",)), | 219 (self.__checkModulesDocstrings, ("D101", "D201")), |
| 220 ], | 220 ], |
| 221 "functionDocstring": [ | 221 "functionDocstring": [ |
| 222 ], | 222 ], |
| 223 "classDocstring": [ | 223 "classDocstring": [ |
| 224 (self.__checkClassDocstring, ("D104", "D205", "D206")), | 224 (self.__checkClassDocstring, ("D104", "D205", "D206")), |
| 228 ], | 228 ], |
| 229 "methodDocstring": [ | 229 "methodDocstring": [ |
| 230 (self.__checkEricSummary, ("D232")), | 230 (self.__checkEricSummary, ("D232")), |
| 231 ], | 231 ], |
| 232 "defDocstring": [ | 232 "defDocstring": [ |
| 233 (self.__checkFunctionDocstring, ("D102", "D203")), | 233 (self.__checkFunctionDocstring, |
| 234 ("D102", "D202.1", "D202.2", "D203")), | |
| 234 (self.__checkImperativeMood, ("D132",)), | 235 (self.__checkImperativeMood, ("D132",)), |
| 235 (self.__checkNoSignature, ("D133",)), | 236 (self.__checkNoSignature, ("D133",)), |
| 236 (self.__checkEricReturn, ("D234r", "D235r")), | 237 (self.__checkEricReturn, ("D234r", "D235r")), |
| 237 (self.__checkEricYield, ("D234y", "D235y")), | 238 (self.__checkEricYield, ("D234y", "D235y")), |
| 238 (self.__checkEricFunctionArguments, | 239 (self.__checkEricFunctionArguments, |
| 693 docstring = docstringContext.ssource() | 694 docstring = docstringContext.ssource() |
| 694 if (not docstring or not docstring.strip() or | 695 if (not docstring or not docstring.strip() or |
| 695 not docstring.strip('\'"')): | 696 not docstring.strip('\'"')): |
| 696 self.__error(context.start(), 0, code) | 697 self.__error(context.start(), 0, code) |
| 697 | 698 |
| 698 if ( | 699 if self.__docType == "eric": |
| 699 self.__docType == "eric" and | 700 if ( |
| 700 docstring.strip('\'"').strip() == | 701 docstring.strip('\'"').strip() == |
| 701 "Function documentation goes here." | 702 "Function documentation goes here." |
| 702 ): | 703 ): |
| 703 self.__error(docstringContext.end(), 0, "D202") | 704 self.__error(docstringContext.end(), 0, "D202.1") |
| 704 return | 705 return |
| 706 | |
| 707 if ( | |
| 708 "DESCRIPTION" in docstring or | |
| 709 "TYPE" in docstring | |
| 710 ): | |
| 711 self.__error(docstringContext.end(), 0, "D202.2") | |
| 712 return | |
| 705 | 713 |
| 706 def __checkClassDocstring(self, docstringContext, context): | 714 def __checkClassDocstring(self, docstringContext, context): |
| 707 """ | 715 """ |
| 708 Private method to check, that all public functions and methods | 716 Private method to check, that all public functions and methods |
| 709 have a docstring. | 717 have a docstring. |
