Skip to content

Commit 1f18c52

Browse files
committed
fix(robot): update class inheritance from BaseOptions to RobotBaseOptions for consistency
Signed-off-by: Daniel Biehl <[email protected]>
1 parent d93a397 commit 1f18c52

File tree

2 files changed

+15
-18
lines changed

2 files changed

+15
-18
lines changed

packages/robot/src/robotcode/robot/config/model.py

Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -697,9 +697,9 @@ class CommonOptions(RobotBaseOptions):
697697
**passed:** remove data only from keywords in passed
698698
test cases and suites
699699
700-
**for:** remove passed iterations from for loops
700+
**for:** remove passed iterations from FOR loops
701701
702-
**while:** remove passed iterations from while loops
702+
**while:** remove passed iterations from WHILE loops
703703
704704
**wuks:** remove all but the last failing keyword
705705
inside `BuiltIn.Wait Until Keyword Succeeds`
@@ -847,7 +847,6 @@ class CommonOptions(RobotBaseOptions):
847847
pattern. Documentation is shown in `Test Details` and
848848
also as a tooltip in `Statistics by Tag`. Pattern can
849849
use `*`, `?` and `[]` as wildcards like --test.
850-
Documentation can contain formatting like --doc.
851850
852851
Examples:
853852
@@ -1130,9 +1129,9 @@ class CommonExtendOptions(RobotBaseOptions):
11301129
**passed:** remove data only from keywords in passed
11311130
test cases and suites
11321131
1133-
**for:** remove passed iterations from for loops
1132+
**for:** remove passed iterations from FOR loops
11341133
1135-
**while:** remove passed iterations from while loops
1134+
**while:** remove passed iterations from WHILE loops
11361135
11371136
**wuks:** remove all but the last failing keyword
11381137
inside `BuiltIn.Wait Until Keyword Succeeds`
@@ -1202,7 +1201,6 @@ class CommonExtendOptions(RobotBaseOptions):
12021201
pattern. Documentation is shown in `Test Details` and
12031202
also as a tooltip in `Statistics by Tag`. Pattern can
12041203
use `*`, `?` and `[]` as wildcards like --test.
1205-
Documentation can contain formatting like --doc.
12061204
12071205
Examples:
12081206
@@ -1862,7 +1860,6 @@ class RebotOptions(RobotBaseOptions):
18621860
Processes output also if the top level suite is
18631861
empty. Useful e.g. with --include/--exclude when it
18641862
is not an error that there are no matches.
1865-
Use --skiponfailure when starting execution instead.
18661863
18671864
corresponds to the `--processemptysuite` option of _rebot_
18681865
""",
@@ -1944,7 +1941,7 @@ class LibDocOptions(RobotBaseOptions):
19441941
quiet: Union[bool, Flag, None] = field(
19451942
description="""\
19461943
Do not print the path of the generated output file
1947-
to the console. New in RF 4.0.
1944+
to the console.
19481945
19491946
corresponds to the `--quiet` option of _libdoc_
19501947
""",
@@ -1959,7 +1956,7 @@ class LibDocOptions(RobotBaseOptions):
19591956
documentation format and HTML means converting
19601957
documentation to HTML. The default is RAW with XML
19611958
spec files and HTML with JSON specs and when using
1962-
the special LIBSPEC format. New in RF 4.0.
1959+
the special LIBSPEC format.
19631960
19641961
corresponds to the `-s --specdocformat RAW|HTML` option of _libdoc_
19651962
""",

scripts/generate_rf_options.py

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -233,31 +233,31 @@ def build_class_fields(output: List[str], opts: Dict[str, Any], extend: bool = F
233233
output.append("")
234234
output.append("")
235235
output.append("@dataclass")
236-
output.append("class CommonOptions(BaseOptions):")
236+
output.append("class CommonOptions(RobotBaseOptions):")
237237
output.append(' """Common options for all _robot_ commands."""')
238238
output.append("")
239239
extra_cmd_options = generate(output, ROBOT_USAGE, RobotSettings._cli_opts, None, extra=False)
240240

241241
output.append("")
242242
output.append("")
243243
output.append("@dataclass")
244-
output.append("class CommonExtendOptions(BaseOptions):")
244+
output.append("class CommonExtendOptions(RobotBaseOptions):")
245245
output.append(' """Extra common options for all _robot_ commands."""')
246246
output.append("")
247247
generate(output, ROBOT_USAGE, RobotSettings._cli_opts, extra_cmd_options, extra=True)
248248

249249
output.append("")
250250
output.append("")
251251
output.append("@dataclass")
252-
output.append("class RobotOptions(BaseOptions):")
252+
output.append("class RobotOptions(RobotBaseOptions):")
253253
output.append(' """Options for _robot_ command."""')
254254
output.append("")
255255
extra_cmd_options = generate(output, ROBOT_USAGE, RobotSettings._extra_cli_opts, None, extra=False)
256256

257257
output.append("")
258258
output.append("")
259259
output.append("@dataclass")
260-
output.append("class RobotExtendOptions(BaseOptions):")
260+
output.append("class RobotExtendOptions(RobotBaseOptions):")
261261
output.append(' """Extra options for _robot_ command."""')
262262
output.append("")
263263
generate(
@@ -272,7 +272,7 @@ def build_class_fields(output: List[str], opts: Dict[str, Any], extend: bool = F
272272
output.append("")
273273
output.append("")
274274
output.append("@dataclass")
275-
output.append("class RebotOptions(BaseOptions):")
275+
output.append("class RebotOptions(RobotBaseOptions):")
276276
output.append(' """Options for _rebot_ command."""')
277277
output.append("")
278278
extra_cmd_options = generate(
@@ -298,15 +298,15 @@ def build_class_fields(output: List[str], opts: Dict[str, Any], extend: bool = F
298298
output.append("")
299299
output.append("")
300300
output.append("@dataclass")
301-
output.append("class LibDocOptions(BaseOptions):")
301+
output.append("class LibDocOptions(RobotBaseOptions):")
302302
output.append(' """Options for _libdoc_ command."""')
303303
output.append("")
304304
extra_cmd_options = generate(output, LIBDOC_USAGE, libdoc_options, None, extra=False, tool="libdoc")
305305

306306
output.append("")
307307
output.append("")
308308
output.append("@dataclass")
309-
output.append("class LibDocExtendOptions(BaseOptions):")
309+
output.append("class LibDocExtendOptions(RobotBaseOptions):")
310310
output.append(' """Extra options for _libdoc_ command."""')
311311
output.append("")
312312
generate(
@@ -328,15 +328,15 @@ def build_class_fields(output: List[str], opts: Dict[str, Any], extend: bool = F
328328
output.append("")
329329
output.append("")
330330
output.append("@dataclass")
331-
output.append("class TestDocOptions(BaseOptions):")
331+
output.append("class TestDocOptions(RobotBaseOptions):")
332332
output.append(' """Options for _testdoc_ command."""')
333333
output.append("")
334334
extra_cmd_options = generate(output, TESTDOC_USAGE, testdoc_options, None, extra=False, tool="testdoc")
335335

336336
output.append("")
337337
output.append("")
338338
output.append("@dataclass")
339-
output.append("class TestDocExtendOptions(BaseOptions):")
339+
output.append("class TestDocExtendOptions(RobotBaseOptions):")
340340
output.append(' """Extra options for _testdoc_ command."""')
341341
output.append("")
342342
generate(

0 commit comments

Comments
 (0)