Doc updates for MSTest #43786
Doc updates for MSTest #43786
Conversation
dotnet-policy-service
bot
added
the
community-contribution
| @@ -38,3 +40,7 @@ Environment variables can be used to supply some runtime configuration informati | |||
|
|
|||
| > [!NOTE] | |||
| > Environment variables take precedence over configuration settings in the *testconfig.json* file. | |||
| ### `TESTINGPLATFORM_UI_LANGUAGE` environment variable | |||
There was a problem hiding this comment.
Is this the right doc page for documenting this? @Evangelink
There was a problem hiding this comment.
I think that's correct. You could check how dotnet cli is structuring this part of the doc, maybe there are some nice things to "copy".
There was a problem hiding this comment.
@Evangelink This is the docs for DOTNET_CLI_UI_LANGUAGE
docs/docs/core/tools/dotnet-environment-variables.md
Lines 335 to 337 in 3208829
| Defines the verbosity level when the `--diagnostic` switch is used. The available values are `Trace`, `Debug`, `Information`, `Warning`, `Error`, or `Critical`. | ||
| Defines the verbosity level when the `--diagnostic` switch is used. The available values are `Trace`, `Debug`, `Information`, `Warning`, `Error`, or `Critical`. | ||
|
|
||
| - **`--exit-on-process-exit`** |
There was a problem hiding this comment.
@Evangelink I wanted to make sure if we want to document this one, or if it was intentionally missing.
There was a problem hiding this comment.
Good question, at the moment we mainly use it to ensure that if some other launching process terminates we also terminates. It feels more technical but maybe it's worth mentioning for users.
WDYT @MarcoRossignoli ?
| The directory where the test results are going to be placed. If the specified directory doesn't exist, it's created. The default is `TestResults` in the directory that contains the test application. | ||
| The directory where the test results are going to be placed. If the specified directory doesn't exist, it's created. The default is `TestResults` in the directory that contains the test application. | ||
|
|
||
| - **`--timeout`** |
There was a problem hiding this comment.
@Evangelink Same here. Do we want to document this? Or was it missing intentionally?
| @@ -38,3 +40,7 @@ Environment variables can be used to supply some runtime configuration informati | |||
|
|
|||
| > [!NOTE] | |||
| > Environment variables take precedence over configuration settings in the *testconfig.json* file. | |||
| ### `TESTINGPLATFORM_UI_LANGUAGE` environment variable | |||
There was a problem hiding this comment.
I think that's correct. You could check how dotnet cli is structuring this part of the doc, maybe there are some nice things to "copy".
| @@ -183,56 +183,72 @@ To run a test project in CI add one step for each test executable that you wish | |||
| The list below described only the platform options. To see the specific options brought by each extension, either refer to the extension documentation page or use the `--help` option. | |||
|
|
|||
| - **`@`** | |||
|
|
|||
| Specifies a response file (rsp). | |||
There was a problem hiding this comment.
I feel like it'd be worth to:
- have a link to doc about rsp concept (if there is some)
- give an inline example
There was a problem hiding this comment.
Not sure what would be the best doc page to link to. But I'll add some more info
| Defines the verbosity level when the `--diagnostic` switch is used. The available values are `Trace`, `Debug`, `Information`, `Warning`, `Error`, or `Critical`. | ||
| Defines the verbosity level when the `--diagnostic` switch is used. The available values are `Trace`, `Debug`, `Information`, `Warning`, `Error`, or `Critical`. | ||
|
|
||
| - **`--exit-on-process-exit`** |
There was a problem hiding this comment.
Good question, at the moment we mainly use it to ensure that if some other launching process terminates we also terminates. It feels more technical but maybe it's worth mentioning for users.
WDYT @MarcoRossignoli ?
| The directory where the test results are going to be placed. If the specified directory doesn't exist, it's created. The default is `TestResults` in the directory that contains the test application. | ||
| The directory where the test results are going to be placed. If the specified directory doesn't exist, it's created. The default is `TestResults` in the directory that contains the test application. | ||
|
|
||
| - **`--timeout`** |
Fixes microsoft/testfx#4157
@Evangelink Can you take a look please?
Internal previews