Mercurial Repositories > eric / annotate

eric7/Plugins/CheckerPlugins/CodeStyleChecker/DocStyle/translations.py@193da71cc417 (annotated)

eric7/Plugins/CheckerPlugins/CodeStyleChecker/DocStyle/translations.py

Sun, 26 Jun 2022 15:16:51 +0200

author
Detlev Offenbach <detlev@die-offenbachs.de>
date
Sun, 26 Jun 2022 15:16:51 +0200
branch
eric7
changeset 9176
193da71cc417
parent 8881
54e42bc2437a
permissions
-rw-r--r--

Changed edge column and max. line length pf code style checker to 88 characters because this gives better looking code (see 'Black' tool).

7784
3257703e10c5 Finished refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
1 # -*- coding: utf-8 -*-
3257703e10c5 Finished refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
2
8881
54e42bc2437a Updated copyright for 2022.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 8318
diff changeset
3 # Copyright (c) 2020 - 2022 Detlev Offenbach <detlev@die-offenbachs.de>
7784
3257703e10c5 Finished refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
4 #
3257703e10c5 Finished refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
5
3257703e10c5 Finished refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
6
3257703e10c5 Finished refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
7 """
3257703e10c5 Finished refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
8 Module implementing message translations for the code style plugin messages
3257703e10c5 Finished refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
9 (code documentation part).
3257703e10c5 Finished refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
10 """
3257703e10c5 Finished refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
11
8318
962bce857696 Replaced all imports of PyQt5 to PyQt6 and started to replace code using obsoleted methods and adapt to the PyQt6 enum usage.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 8312
diff changeset
12 from PyQt6.QtCore import QCoreApplication
7784
3257703e10c5 Finished refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
13
3257703e10c5 Finished refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
14 _docStyleMessages = {
3257703e10c5 Finished refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
15 "D101": QCoreApplication.translate(
3257703e10c5 Finished refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
16 "DocStyleChecker", "module is missing a docstring"),
3257703e10c5 Finished refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
17 "D102": QCoreApplication.translate(
3257703e10c5 Finished refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
18 "DocStyleChecker",
3257703e10c5 Finished refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
19 "public function/method is missing a docstring"),
3257703e10c5 Finished refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
20 "D103": QCoreApplication.translate(
3257703e10c5 Finished refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
21 "DocStyleChecker",
3257703e10c5 Finished refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
22 "private function/method may be missing a docstring"),
3257703e10c5 Finished refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
23 "D104": QCoreApplication.translate(
3257703e10c5 Finished refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
24 "DocStyleChecker", "public class is missing a docstring"),
3257703e10c5 Finished refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
25 "D105": QCoreApplication.translate(
3257703e10c5 Finished refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
26 "DocStyleChecker", "private class may be missing a docstring"),
3257703e10c5 Finished refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
27 "D111": QCoreApplication.translate(
3257703e10c5 Finished refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
28 "DocStyleChecker", 'docstring not surrounded by """'),
3257703e10c5 Finished refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
29 "D112": QCoreApplication.translate(
3257703e10c5 Finished refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
30 "DocStyleChecker",
3257703e10c5 Finished refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
31 'docstring containing \\ not surrounded by r"""'),
3257703e10c5 Finished refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
32 "D121": QCoreApplication.translate(
3257703e10c5 Finished refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
33 "DocStyleChecker", "one-liner docstring on multiple lines"),
3257703e10c5 Finished refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
34 "D122": QCoreApplication.translate(
3257703e10c5 Finished refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
35 "DocStyleChecker", "docstring has wrong indentation"),
3257703e10c5 Finished refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
36 "D130": QCoreApplication.translate(
3257703e10c5 Finished refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
37 "DocStyleChecker", "docstring does not contain a summary"),
3257703e10c5 Finished refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
38 "D131": QCoreApplication.translate(
3257703e10c5 Finished refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
39 "DocStyleChecker", "docstring summary does not end with a period"),
3257703e10c5 Finished refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
40 "D132": QCoreApplication.translate(
3257703e10c5 Finished refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
41 "DocStyleChecker",
3257703e10c5 Finished refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
42 "docstring summary is not in imperative mood"
3257703e10c5 Finished refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
43 " (Does instead of Do)"),
3257703e10c5 Finished refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
44 "D133": QCoreApplication.translate(
3257703e10c5 Finished refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
45 "DocStyleChecker",
3257703e10c5 Finished refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
46 "docstring summary looks like a function's/method's signature"),
3257703e10c5 Finished refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
47 "D134": QCoreApplication.translate(
3257703e10c5 Finished refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
48 "DocStyleChecker",
3257703e10c5 Finished refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
49 "docstring does not mention the return value type"),
3257703e10c5 Finished refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
50 "D141": QCoreApplication.translate(
3257703e10c5 Finished refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
51 "DocStyleChecker",
3257703e10c5 Finished refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
52 "function/method docstring is separated by a blank line"),
3257703e10c5 Finished refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
53 "D142": QCoreApplication.translate(
3257703e10c5 Finished refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
54 "DocStyleChecker",
3257703e10c5 Finished refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
55 "class docstring is not preceded by a blank line"),
3257703e10c5 Finished refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
56 "D143": QCoreApplication.translate(
3257703e10c5 Finished refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
57 "DocStyleChecker",
3257703e10c5 Finished refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
58 "class docstring is not followed by a blank line"),
3257703e10c5 Finished refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
59 "D144": QCoreApplication.translate(
3257703e10c5 Finished refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
60 "DocStyleChecker",
3257703e10c5 Finished refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
61 "docstring summary is not followed by a blank line"),
3257703e10c5 Finished refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
62 "D145": QCoreApplication.translate(
3257703e10c5 Finished refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
63 "DocStyleChecker",
3257703e10c5 Finished refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
64 "last paragraph of docstring is not followed by a blank line"),
3257703e10c5 Finished refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
65
3257703e10c5 Finished refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
66 "D201": QCoreApplication.translate(
3257703e10c5 Finished refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
67 "DocStyleChecker", "module docstring is still a default string"),
7998
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7987
diff changeset
68 "D202.1": QCoreApplication.translate(
7784
3257703e10c5 Finished refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
69 "DocStyleChecker", "function docstring is still a default string"),
7998
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7987
diff changeset
70 "D202.2": QCoreApplication.translate(
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7987
diff changeset
71 "DocStyleChecker",
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7987
diff changeset
72 "function docstring still contains some placeholders"),
7784
3257703e10c5 Finished refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
73 "D203": QCoreApplication.translate(
3257703e10c5 Finished refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
74 "DocStyleChecker",
3257703e10c5 Finished refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
75 "private function/method is missing a docstring"),
3257703e10c5 Finished refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
76 "D205": QCoreApplication.translate(
3257703e10c5 Finished refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
77 "DocStyleChecker", "private class is missing a docstring"),
3257703e10c5 Finished refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
78 "D206": QCoreApplication.translate(
3257703e10c5 Finished refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
79 "DocStyleChecker", "class docstring is still a default string"),
3257703e10c5 Finished refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
80 "D221": QCoreApplication.translate(
3257703e10c5 Finished refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
81 "DocStyleChecker",
3257703e10c5 Finished refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
82 "leading quotes of docstring not on separate line"),
3257703e10c5 Finished refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
83 "D222": QCoreApplication.translate(
3257703e10c5 Finished refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
84 "DocStyleChecker",
3257703e10c5 Finished refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
85 "trailing quotes of docstring not on separate line"),
3257703e10c5 Finished refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
86 "D231": QCoreApplication.translate(
3257703e10c5 Finished refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
87 "DocStyleChecker", "docstring summary does not end with a period"),
3257703e10c5 Finished refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
88 "D232": QCoreApplication.translate(
3257703e10c5 Finished refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
89 "DocStyleChecker", "docstring summary does not start with '{0}'"),
7987
e8eb8370ea94 Source code documentation generator, doc checker: added support for @yield and @ytype.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7923
diff changeset
90 "D234r": QCoreApplication.translate(
7784
3257703e10c5 Finished refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
91 "DocStyleChecker",
3257703e10c5 Finished refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
92 "docstring does not contain a @return line but function/method"
3257703e10c5 Finished refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
93 " returns something"),
7987
e8eb8370ea94 Source code documentation generator, doc checker: added support for @yield and @ytype.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7923
diff changeset
94 "D235r": QCoreApplication.translate(
7784
3257703e10c5 Finished refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
95 "DocStyleChecker",
3257703e10c5 Finished refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
96 "docstring contains a @return line but function/method doesn't"
3257703e10c5 Finished refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
97 " return anything"),
7987
e8eb8370ea94 Source code documentation generator, doc checker: added support for @yield and @ytype.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7923
diff changeset
98 "D234y": QCoreApplication.translate(
e8eb8370ea94 Source code documentation generator, doc checker: added support for @yield and @ytype.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7923
diff changeset
99 "DocStyleChecker",
e8eb8370ea94 Source code documentation generator, doc checker: added support for @yield and @ytype.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7923
diff changeset
100 "docstring does not contain a @yield line but function/method"
e8eb8370ea94 Source code documentation generator, doc checker: added support for @yield and @ytype.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7923
diff changeset
101 " yields something"),
e8eb8370ea94 Source code documentation generator, doc checker: added support for @yield and @ytype.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7923
diff changeset
102 "D235y": QCoreApplication.translate(
e8eb8370ea94 Source code documentation generator, doc checker: added support for @yield and @ytype.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7923
diff changeset
103 "DocStyleChecker",
e8eb8370ea94 Source code documentation generator, doc checker: added support for @yield and @ytype.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7923
diff changeset
104 "docstring contains a @yield line but function/method doesn't"
e8eb8370ea94 Source code documentation generator, doc checker: added support for @yield and @ytype.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7923
diff changeset
105 " yield anything"),
7784
3257703e10c5 Finished refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
106 "D236": QCoreApplication.translate(
3257703e10c5 Finished refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
107 "DocStyleChecker",
3257703e10c5 Finished refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
108 "docstring does not contain enough @param/@keyparam lines"),
3257703e10c5 Finished refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
109 "D237": QCoreApplication.translate(
3257703e10c5 Finished refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
110 "DocStyleChecker",
3257703e10c5 Finished refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
111 "docstring contains too many @param/@keyparam lines"),
3257703e10c5 Finished refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
112 "D238": QCoreApplication.translate(
3257703e10c5 Finished refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
113 "DocStyleChecker",
3257703e10c5 Finished refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
114 "keyword only arguments must be documented with @keyparam lines"),
3257703e10c5 Finished refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
115 "D239": QCoreApplication.translate(
3257703e10c5 Finished refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
116 "DocStyleChecker", "order of @param/@keyparam lines does"
3257703e10c5 Finished refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
117 " not match the function/method signature"),
3257703e10c5 Finished refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
118 "D242": QCoreApplication.translate(
3257703e10c5 Finished refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
119 "DocStyleChecker", "class docstring is preceded by a blank line"),
3257703e10c5 Finished refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
120 "D243": QCoreApplication.translate(
3257703e10c5 Finished refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
121 "DocStyleChecker", "class docstring is followed by a blank line"),
3257703e10c5 Finished refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
122 "D244": QCoreApplication.translate(
3257703e10c5 Finished refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
123 "DocStyleChecker",
3257703e10c5 Finished refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
124 "function/method docstring is preceded by a blank line"),
3257703e10c5 Finished refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
125 "D245": QCoreApplication.translate(
3257703e10c5 Finished refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
126 "DocStyleChecker",
3257703e10c5 Finished refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
127 "function/method docstring is followed by a blank line"),
3257703e10c5 Finished refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
128 "D246": QCoreApplication.translate(
3257703e10c5 Finished refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
129 "DocStyleChecker",
3257703e10c5 Finished refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
130 "docstring summary is not followed by a blank line"),
3257703e10c5 Finished refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
131 "D247": QCoreApplication.translate(
3257703e10c5 Finished refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
132 "DocStyleChecker",
3257703e10c5 Finished refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
133 "last paragraph of docstring is followed by a blank line"),
3257703e10c5 Finished refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
134 "D250": QCoreApplication.translate(
3257703e10c5 Finished refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
135 "DocStyleChecker",
3257703e10c5 Finished refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
136 "docstring does not contain a @exception line but function/method"
3257703e10c5 Finished refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
137 " raises an exception"),
3257703e10c5 Finished refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
138 "D251": QCoreApplication.translate(
3257703e10c5 Finished refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
139 "DocStyleChecker",
3257703e10c5 Finished refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
140 "docstring contains a @exception line but function/method doesn't"
3257703e10c5 Finished refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
141 " raise an exception"),
3257703e10c5 Finished refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
142 "D252": QCoreApplication.translate(
3257703e10c5 Finished refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
143 "DocStyleChecker",
3257703e10c5 Finished refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
144 "raised exception '{0}' is not documented in docstring"),
3257703e10c5 Finished refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
145 "D253": QCoreApplication.translate(
3257703e10c5 Finished refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
146 "DocStyleChecker",
3257703e10c5 Finished refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
147 "documented exception '{0}' is not raised"),
3257703e10c5 Finished refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
148 "D260": QCoreApplication.translate(
3257703e10c5 Finished refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
149 "DocStyleChecker",
3257703e10c5 Finished refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
150 "docstring does not contain a @signal line but class defines signals"),
3257703e10c5 Finished refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
151 "D261": QCoreApplication.translate(
3257703e10c5 Finished refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
152 "DocStyleChecker",
3257703e10c5 Finished refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
153 "docstring contains a @signal line but class doesn't define signals"),
3257703e10c5 Finished refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
154 "D262": QCoreApplication.translate(
3257703e10c5 Finished refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
155 "DocStyleChecker",
3257703e10c5 Finished refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
156 "defined signal '{0}' is not documented in docstring"),
3257703e10c5 Finished refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
157 "D263": QCoreApplication.translate(
3257703e10c5 Finished refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
158 "DocStyleChecker",
3257703e10c5 Finished refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
159 "documented signal '{0}' is not defined"),
3257703e10c5 Finished refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
160 }
3257703e10c5 Finished refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
161
3257703e10c5 Finished refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
162 _docStyleMessagesSampleArgs = {
3257703e10c5 Finished refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
163 "D232": ["public"],
3257703e10c5 Finished refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
164 "D252": ["RuntimeError"],
3257703e10c5 Finished refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
165 "D253": ["RuntimeError"],
3257703e10c5 Finished refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
166 "D262": ["buttonClicked"],
3257703e10c5 Finished refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
167 "D263": ["buttonClicked"],
3257703e10c5 Finished refactoring the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
168 }

Mercurial Repository: eric

eric ide

mercurial