Skip to content
This repository was archived by the owner on Mar 27, 2025. It is now read-only.

Commit 0d980aa

Browse files
authored
reacting to technical review feedback
1 parent 23ed4e6 commit 0d980aa

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

CONFIGDOC.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -81,10 +81,10 @@ By default, the **Run MATLAB Tests** step creates a test suite from all the test
8181

8282
To customize your test run, select options in the **Customize Test Run** section:
8383

84-
* To apply strict checks when running the tests, select **Strict**. When you select this option, the plugin generates a qualification failure whenever a test issues a warning. Selecting **Strict** is the same as specifying the `Strict` name-value argument of [`runtests`](https://www.mathworks.com/help/matlab/ref/runtests.html) as `true`.
85-
* To run tests in parallel (requires Parallel Computing Toolbox™), select **Use Parallel**. This feature might not be compatible with certain options, in which case, the plugin runs the tests in serial regardless of your selection. Selecting **Use parallel** is the same as specifying the `UseParallel` name-value argument of `runtests` as `true`.
86-
* To control the amount of event detail displayed for your test run, select a value from the **Output detail** list. Selecting a value for this option is the same as specifying the `OutputDetail` name-value argument of `runtests` as that value.
87-
* To display diagnostics logged by the [`log (TestCase)`](https://www.mathworks.com/help/matlab/ref/matlab.unittest.testcase.log.html) or [`log (Fixture)`](https://www.mathworks.com/help/matlab/ref/matlab.unittest.fixtures.fixture.log.html) methods at a specified verbosity level and below, select a value from the **Logging level** list. Selecting a value for this option is the same as specifying the `LoggingLevel` name-value argument of `runtests` as that value.
84+
* To apply strict checks when running the tests, select **Strict**. When you select this option, the plugin generates a qualification failure whenever a test issues a warning. Selecting **Strict** is the same as specifying the `Strict` name-value argument of the [`runtests`](https://www.mathworks.com/help/matlab/ref/runtests.html) function as `true`.
85+
* To run tests in parallel, select **Use Parallel**. This feature might not be compatible with certain options, in which case, the plugin runs the tests in serial regardless of your choice. Selecting **Use parallel** is the same as specifying the `UseParallel` name-value argument of `runtests` as `true`. You must have Parallel Computing Toolbox™ installed to use this option.
86+
* To control the amount of event detail displayed for your test run, select a value from the **Output detail** list. Selecting a value for this option is the same as specifying the `OutputDetail` name-value argument of `runtests` as that value. By default, the plugin displays failing and logged events at the `Detailed` level and test run progress at the `Concise` level.
87+
* To include diagnostics logged by the [`log (TestCase)`](https://www.mathworks.com/help/matlab/ref/matlab.unittest.testcase.log.html) or [`log (Fixture)`](https://www.mathworks.com/help/matlab/ref/matlab.unittest.fixtures.fixture.log.html) methods at a specified verbosity level and below, select a value from the **Logging level** list. Selecting a value for this option is the same as specifying the `LoggingLevel` name-value argument of `runtests` as that value. By default, the plugin includes diagnostics logged at the `Terse` level.
8888

8989
![run_matlab_tests_customization](https://user-images.githubusercontent.com/48831250/193946910-9b8fa6ff-5439-413a-a19c-50277d2a7f6f.png)
9090

@@ -284,9 +284,9 @@ Input | Description
284284
`selectByFolder` | (Optional) Location of the folder used to select test suite elements, relative to the project root folder. To create a test suite, the plugin uses only the tests in the specified folder and its subfolders.<br/>**Example:** `['test']`<br/>**Example:** `['test/folderA', 'test/folderB']`
285285
`selectByTag` | (Optional) Test tag used to select test suite elements. To create a test suite, the plugin uses only the test elements with the specified tag.<br/>**Example:** `'FeatureA'`
286286
`strict` | (Optional) Whether to apply strict checks when running the tests, specified as `false` or `true`. By default, the value is `false`. If you specify a value of `true`, the plugin generates a qualification failure whenever a test issues a warning.
287-
`useParallel` | (Optional) Whether to run tests in parallel, specified as `false` or `true`. By default, the value is `false` and tests run in serial. If the test runner configuration is suited for parallelization, you can specify a value of `true` to run tests in parallel. This input requires a Parallel Computing Toolbox&trade; license.
288-
`outputDetail` | (Optional) Amount of event detail displayed for the test run, specified as `none`, `terse`, `concise`, `detailed`, or `verbose`. Selecting a value for this input is the same as specifying the `OutputDetail` name-value argument of [`runtests`](https://www.mathworks.com/help/matlab/ref/runtests.html) as that value.
289-
`loggingLevel` | (Optional) Maximum verbosity level for logged diagnostics included for the test run, specified as `none`, `terse`, `concise`, `detailed`, or `verbose`. Selecting a value for this input is the same as specifying the `LoggingLevel` name-value argument of `runtests` as that value.
287+
`useParallel` | (Optional) Whether to run tests in parallel, specified as `false` or `true`. By default, the value is `false` and tests run in serial. If the test runner configuration is suited for parallelization, you can specify a value of `true` to run tests in parallel. This input requires a Parallel Computing Toolbox license.
288+
`outputDetail` | (Optional) Amount of event detail displayed for the test run, specified as `'None'`, `'Terse'`, `'Concise'`, `'Detailed'`, or `'Verbose'`. Selecting a value for this input is the same as specifying the `OutputDetail` name-value argument of [`runtests`](https://www.mathworks.com/help/matlab/ref/runtests.html) as that value. By default, the plugin displays failing and logged events at the `Detailed` level and test run progress at the `Concise` level.
289+
`loggingLevel` | (Optional) Maximum verbosity level for logged diagnostics included for the test run, specified as `'None'`, `'Terse'`, `'Concise'`, `'Detailed'`, or `'Verbose'`. Selecting a value for this input is the same as specifying the `LoggingLevel` name-value argument of `runtests` as that value. By default, the plugin includes diagnostics logged at the `Terse` level.
290290
`testResultsPDF` | (Optional) Path to write test results report in PDF format. On macOS platforms, this input is supported in MATLAB R2020b and later.<br/>**Example:** `'test-results/results.pdf'`
291291
`testResultsTAP` | (Optional) Path to write test results report in TAP format.<br/>**Example:** `'test-results/results.tap'`
292292
`testResultsJUnit` | (Optional) Path to write test results report in JUnit XML format.<br/>**Example:** `'test-results/results.xml'`

0 commit comments

Comments
 (0)