Skip to content

Commit 229a4a6

Browse files
d-biehld-biehl
committed
fix: use markdownDescription in settings and launch configurations where needed
1 parent 4817f49 commit 229a4a6

File tree

1 file changed

+30
-34
lines changed

1 file changed

+30
-34
lines changed

‎package.json

Lines changed: 30 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -350,7 +350,7 @@
350350
"items": {
351351
"type": "string"
352352
},
353-
"description": "Specifies the arguments to be passed to the language server (i.e.: [\"--log\", \"--log-file=~/robotcode.log\"]). Requires a VSCode restart to take effect.",
353+
"markdownDescription": "Specifies the arguments to be passed to the language server (i.e.: [`--log`, `--log-file=~/robotcode.log`]). Requires a VSCode restart to take effect.",
354354
"scope": "resource"
355355
},
356356
"robotcode.debugAdapter.mode": {
@@ -381,7 +381,7 @@
381381
"items": {
382382
"type": "string"
383383
},
384-
"description": "Specifies the arguments to be passed to the debug adapter (i.e.: [\"--log\", \"--log-file=~/debug-adapter.log\"]). Requires a VSCode restart to take effect.",
384+
"markdownDescription": "Specifies the arguments to be passed to the debug adapter (i.e.: [`--log`, `--log-file=~/debug-adapter.log`]). Requires a VSCode restart to take effect.",
385385
"scope": "resource"
386386
},
387387
"robotcode.robot.args": {
@@ -399,7 +399,7 @@
399399
"items": {
400400
"type": "string"
401401
},
402-
"description": "Specifies the paths where robot/robotcode should discover tests. Corresponds to the 'paths' option of robot.",
402+
"markdownDescription": "Specifies the paths where robot/robotcode should discover tests. Corresponds to the `paths` option of __robot__.",
403403
"scope": "resource"
404404
},
405405
"robotcode.robot.pythonPath": {
@@ -411,7 +411,7 @@
411411
"items": {
412412
"type": "string"
413413
},
414-
"description": "Specifies additional python paths for robotframework. Corresponds to the '--pythonpath' option of robot.",
414+
"markdownDescription": "Specifies additional python paths for robotframework. Corresponds to the `--pythonpath` option of __robot__.",
415415
"scope": "resource"
416416
},
417417
"robotcode.robot.env": {
@@ -429,7 +429,7 @@
429429
"items": {
430430
"type": "string"
431431
},
432-
"markdownDescription": "Specifies the supported language(s) that can be used to write _robot_ files. Corresponds to the '`--language lang *`' option of __robot__.",
432+
"markdownDescription": "Specifies the supported language(s) that can be used to write _robot_ files. Corresponds to the `--language lang *` option of __robot__.",
433433
"scope": "resource"
434434
},
435435
"robotcode.robot.variables": {
@@ -438,7 +438,7 @@
438438
"additionalProperties": {
439439
"type": "string"
440440
},
441-
"description": "Specifies the variables for robotframework. Corresponds to the '--variable name:value' option of robot.",
441+
"markdownDescription": "Specifies the variables for robotframework. Corresponds to the `--variable name:value` option of __robot__.",
442442
"scope": "resource"
443443
},
444444
"robotcode.robot.variableFiles": {
@@ -447,13 +447,13 @@
447447
"items": {
448448
"type": "string"
449449
},
450-
"description": "Specifies the variable files for robotframework. Corresponds to the '--variablefile' option of robot.",
450+
"markdownDescription": "Specifies the variable files for robotframework. Corresponds to the `--variablefile` option of __robot__.",
451451
"scope": "resource"
452452
},
453453
"robotcode.robot.outputDir": {
454454
"type": "string",
455455
"default": "results",
456-
"description": "Specifies the output directory where robotframework saves output files.",
456+
"markdownDescription": "Specifies the output directory where robotframework saves output files. Corresponds to the `--outputdir` option of __robot__.",
457457
"scope": "resource"
458458
},
459459
"robotcode.robot.mode": {
@@ -463,12 +463,12 @@
463463
"rpa",
464464
"norpa"
465465
],
466-
"enumDescriptions": [
466+
"markdownEnumDescriptions": [
467467
"Mode is got from test/task header in data files.",
468-
"Turn on the generic automation mode. Corresponds to the '--rpa' option of robot.",
469-
"Force test automation mode. Corresponds to the '--norpa' option of robot."
468+
"Turn on the generic automation mode. Corresponds to the `--rpa` option of __robot__.",
469+
"Force test automation mode. Corresponds to the `--norpa` option of __robot__."
470470
],
471-
"description": "Specifies robot execution mode.",
471+
"markdownDescription": "Specifies robot execution mode. Corresponds to the `--rpa` or `--norpa` option of __robot__.",
472472
"default": "default",
473473
"scope": "resource"
474474
},
@@ -492,9 +492,7 @@
492492
"items": {
493493
"type": "string"
494494
},
495-
"markdownDescription": [
496-
"Specifies the library names that should not be cached. This is useful if you have a dynamic or hybrid library that has different keywords depending on the arguments. You can specify a glob pattern that matches the library name or the source file. \n\nExamples:\n- `**/mylibfolder/mylib.py`\n- `MyLib`\n- `mylib.subpackage.subpackage` \n\nFor robot framework internal libraries, you have to specify the full module name like `robot.libraries.Remote`.\n\nIf you change this setting, you may need to run the command `Robot Code: Clear Cache and Restart Language Servers`."
497-
],
495+
"markdownDescription": "Specifies the library names that should not be cached. This is useful if you have a dynamic or hybrid library that has different keywords depending on the arguments. You can specify a glob pattern that matches the library name or the source file. \n\nExamples:\n- `**/mylibfolder/mylib.py`\n- `MyLib`\n- `mylib.subpackage.subpackage` \n\nFor robot framework internal libraries, you have to specify the full module name like `robot.libraries.Remote`.\n\nIf you change this setting, you may need to run the command `Robot Code: Clear Cache and Restart Language Servers`.",
498496
"scope": "resource"
499497
},
500498
"robotcode.analysis.cache.ignoredVariables": {
@@ -503,9 +501,7 @@
503501
"items": {
504502
"type": "string"
505503
},
506-
"markdownDescription": [
507-
"Specifies the variable files that should not be cached. This is useful if you have a dynamic or hybrid variable files that has different variables depending on the arguments. You can specify a glob pattern that matches the variable module name or the source file. \n\nExamples:\n- `**/variables/myvars.py`\n- `MyVariables`\n- `myvars.subpackage.subpackage` \n\nIf you change this setting, you may need to run the command `Robot Code: Clear Cache and Restart Language Servers`."
508-
],
504+
"markdownDescription": "Specifies the variable files that should not be cached. This is useful if you have a dynamic or hybrid variable files that has different variables depending on the arguments. You can specify a glob pattern that matches the variable module name or the source file. \n\nExamples:\n- `**/variables/myvars.py`\n- `MyVariables`\n- `myvars.subpackage.subpackage` \n\nIf you change this setting, you may need to run the command `Robot Code: Clear Cache and Restart Language Servers`.",
509505
"scope": "resource"
510506
},
511507
"robotcode.run.openOutputAfterRun": {
@@ -855,7 +851,7 @@
855851
"string",
856852
"null"
857853
],
858-
"description": "The .robot file or a folder containing .robot files to be launched.",
854+
"markdownDescription": "The `.robot` file or a folder containing `.robot` files to be launched.",
859855
"default": "${file}"
860856
},
861857
"paths": {
@@ -864,7 +860,7 @@
864860
"items": {
865861
"type": "string"
866862
},
867-
"description": "Specifies the paths where robot should discover tests. Corresponds to the 'paths' option of robot."
863+
"markdownDescription": "Specifies the paths where robot should discover tests. Corresponds to the 'paths' option of __robot__."
868864
},
869865
"args": {
870866
"type": "array",
@@ -901,7 +897,7 @@
901897
},
902898
"dryRun": {
903899
"type": "boolean",
904-
"description": "Verifies test data and runs tests so that library keywords are not executed. Corresponds to the '--dryrun' option of robot.",
900+
"markdownDescription": "Verifies test data and runs tests so that library keywords are not executed. Corresponds to the `--dryrun` option of __robot__.",
905901
"default": false
906902
},
907903
"python": {
@@ -914,7 +910,7 @@
914910
"items": {
915911
"type": "string"
916912
},
917-
"description": "Specifies additional python paths for robotframework. Corresponds to the '--pythonpath' option of robot.",
913+
"markdownDescription": "Specifies additional python paths for robotframework. Corresponds to the `--pythonpath` option of __robot__.",
918914
"default": []
919915
},
920916
"attachPython": {
@@ -936,39 +932,39 @@
936932
"items": {
937933
"type": "string"
938934
},
939-
"markdownDescription": "Specifies the supported language(s) that can be used to write _robot_ files. Corresponds to the '`--language lang *`' option of __robot__."
935+
"markdownDescription": "Specifies the supported language(s) that can be used to write _robot_ files. Corresponds to the `--language lang *` option of __robot__."
940936
},
941937
"variables": {
942938
"type": "object",
943939
"additionalProperties": {
944940
"type": "string"
945941
},
946942
"default": {},
947-
"description": "Specifies the variables for robotframework. Corresponds to the '--variable name:value' option of robot."
943+
"markdownDescription": "Specifies the variables for robotframework. Corresponds to the `--variable name:value` option of __robot__."
948944
},
949945
"variableFiles": {
950946
"type": "array",
951947
"default": [],
952948
"items": {
953949
"type": "string"
954950
},
955-
"description": "Specifies the variable files for robotframework. Corresponds to the '--variablefile' option of robot."
951+
"markdownDescription": "Specifies the variable files for robotframework. Corresponds to the `--variablefile path *` option of __robot__."
956952
},
957953
"include": {
958954
"type": "array",
959955
"default": [],
960956
"items": {
961957
"type": "string"
962958
},
963-
"description": "Specifies the tags that should be included in test run. Corresponds to the '--include' option of robot."
959+
"markdownDescription": "Specifies the tags that should be included in test run. Corresponds to the `--include tag * ` option of __robot__."
964960
},
965961
"exclude": {
966962
"type": "array",
967963
"default": [],
968964
"items": {
969965
"type": "string"
970966
},
971-
"description": "Specifies the tags that should be excluded in test run. Corresponds to the '--excluded' option of robot."
967+
"markdownDescription": "Specifies the tags that should be excluded in test run. Corresponds to the `--excluded tag *` option of __robot__."
972968
},
973969
"launcherArgs": {
974970
"type": "array",
@@ -993,7 +989,7 @@
993989
"outputDir": {
994990
"type": "string",
995991
"default": null,
996-
"description": "Specifies the output directory where robotframework saves output files."
992+
"markdownDescription": "Specifies the output directory where robotframework saves output files. Corresponds to the `--outputdir` option of __robot__."
997993
},
998994
"outputMessages": {
999995
"type": "boolean",
@@ -1017,10 +1013,10 @@
10171013
"rpa",
10181014
"norpa"
10191015
],
1020-
"enumDescriptions": [
1016+
"markdownEnumDescriptions": [
10211017
"Mode is got from test/task header in data files.",
1022-
"Turn on the generic automation mode. Corresponds to the '--rpa' option of robot.",
1023-
"Force test automation mode. Corresponds to the '--norpa' option of robot."
1018+
"Turn on the generic automation mode. Corresponds to the `--rpa` option of __robot__.",
1019+
"Force test automation mode. Corresponds to the `--norpa` option of __robot__."
10241020
],
10251021
"description": "Specifies robot execution mode.",
10261022
"default": "default"
@@ -1058,10 +1054,10 @@
10581054
"report",
10591055
"log"
10601056
],
1061-
"enumDescriptions": [
1057+
"markdownEnumDescriptions": [
10621058
"Do not open anyting",
1063-
"Open the report html file.",
1064-
"Open the log.html file."
1059+
"Open the `report.html` file.",
1060+
"Open the `log.html` file."
10651061
],
10661062
"default": "none",
10671063
"description": "Defines if the report or log file should be opened after a run."

0 commit comments

Comments
 (0)