Skip to content

Commit bd633de

Browse files
committed
Update design
1 parent 6f1f32e commit bd633de

File tree

1 file changed

+17
-10
lines changed

1 file changed

+17
-10
lines changed

docs/design.rst

+17-10
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,6 @@ Class Diagram
1818
class "CoverityChecker" as mlx.warnings.regex_checker.CoverityChecker {
1919
checkers : dict
2020
count : int
21-
counted_warnings
2221
cq_default_path
2322
cq_description_template
2423
cq_findings
@@ -34,10 +33,14 @@ Class Diagram
3433
classification
3534
count
3635
cq_description_template
36+
logging_fmt : str
3737
name : str
3838
add_code_quality_finding(match)
3939
check(content)
4040
}
41+
class "DebugOnlyFilter" as mlx.warnings.warnings_checker.DebugOnlyFilter {
42+
filter(record: logging.LogRecord) -> bool
43+
}
4144
class "DoxyChecker" as mlx.warnings.regex_checker.DoxyChecker {
4245
name : str
4346
pattern
@@ -55,13 +58,13 @@ Class Diagram
5558
class "JUnitChecker" as mlx.warnings.junit_checker.JUnitChecker {
5659
count
5760
name : str
61+
name_repr
5862
check(content)
5963
prepare_tree(root_input)
6064
}
6165
class "PolyspaceChecker" as mlx.warnings.polyspace_checker.PolyspaceChecker {
6266
checkers : list
6367
count : int
64-
counted_warnings
6568
cq_default_path
6669
cq_description_template
6770
cq_findings
@@ -80,6 +83,7 @@ Class Diagram
8083
count
8184
cq_description_template
8285
family_value
86+
logging_fmt : str
8387
name : str
8488
add_code_quality_finding(row)
8589
check(content)
@@ -95,7 +99,7 @@ Class Diagram
9599
class "RobotChecker" as mlx.warnings.robot_checker.RobotChecker {
96100
checkers : list
97101
count : int
98-
counted_warnings
102+
logging_fmt : str
99103
maximum
100104
minimum
101105
name : str
@@ -107,8 +111,10 @@ Class Diagram
107111
class "RobotSuiteChecker" as mlx.warnings.robot_checker.RobotSuiteChecker {
108112
check_suite_name : bool
109113
is_valid_suite_name : bool
114+
logging_fmt : str
110115
name : str
111116
suite_name
117+
suite_name_repr
112118
check(content)
113119
}
114120
class "SphinxChecker" as mlx.warnings.regex_checker.SphinxChecker {
@@ -120,21 +126,24 @@ Class Diagram
120126
}
121127
class "WarningsChecker" as mlx.warnings.warnings_checker.WarningsChecker {
122128
count : int
123-
counted_warnings
124129
cq_default_path : str
125130
cq_description_template
126131
cq_enabled : bool
127132
cq_findings
128133
exclude_patterns : list
129134
include_patterns : list
135+
is_sub_checker
136+
logger : LoggerAdapter, NoneType, RootLogger
137+
logging_args : tuple
138+
logging_fmt : str
130139
maximum
131140
minimum
132141
name : str
133-
verbose : bool
142+
name_repr
134143
add_patterns(regexes, pattern_container)
135144
{abstract}check(content)
136145
parse_config(config)
137-
return_check_limits(extra)
146+
return_check_limits()
138147
return_count()
139148
}
140149
class "<color:red>WarningsConfigError</color>" as mlx.warnings.exceptions.WarningsConfigError {
@@ -144,9 +153,8 @@ Class Diagram
144153
count : int
145154
cq_enabled : bool
146155
printout : bool
147-
public_checkers : list
148-
verbose : bool
149-
activate_checker(checker)
156+
public_checkers : tuple
157+
activate_checker(checker_type)
150158
activate_checker_name(name)
151159
check(content)
152160
check_logfile(file)
@@ -158,7 +166,6 @@ Class Diagram
158166
return_count(name)
159167
toggle_printout(printout)
160168
write_code_quality_report(out_file)
161-
write_counted_warnings(out_file)
162169
}
163170
class "XMLRunnerChecker" as mlx.warnings.regex_checker.XMLRunnerChecker {
164171
name : str

0 commit comments

Comments
 (0)