MSTest SDK document limitations #43717
Conversation
Co-authored-by: Youssef Victor <[email protected]>
Co-authored-by: Youssef Victor <[email protected]>
|
@IEvangelist ready for review |
| @@ -254,6 +254,14 @@ Here's an example update when using the `DotNetCoreCLI` task in Azure DevOps: | |||
| + arguments: '--configuration Release -p:TestingPlatformCommandLineArguments="--report-trx --results-directory $(Agent.TempDirectory) --coverage"' | |||
| ``` | |||
|
|
|||
| ## Known limitations | |||
|
|
|||
| The MSTest SDK has limited integration with NuGet, meaning that the usual NuGet update and Visual Studio UI for managing NuGet packages won't work as expected. See this issue for more details: [NuGet#13127](https://github.com/NuGet/Home/issues/13127). | |||
There was a problem hiding this comment.
| The MSTest SDK has limited integration with NuGet, meaning that the usual NuGet update and Visual Studio UI for managing NuGet packages won't work as expected. See this issue for more details: [NuGet#13127](https://github.com/NuGet/Home/issues/13127). | |
| The MSTest SDK has limited integration with NuGet, meaning that the usual NuGet update and Visual Studio UI for managing NuGet packages **DOES NOT** work as expected. See this issue for more details: [NuGet#13127](https://github.com/NuGet/Home/issues/13127). |
or maybe make this whole thing a Warning note?
There was a problem hiding this comment.
I started with it as warning section above in the file but there was too many notes and warnings making things confusing. Making a warning section here would mean we have 2 notes only, I don't know if that's ok.
I'll doc team suggest what's best.
Co-authored-by: Jakub Jareš <[email protected]>
| @@ -254,6 +254,14 @@ Here's an example update when using the `DotNetCoreCLI` task in Azure DevOps: | |||
| + arguments: '--configuration Release -p:TestingPlatformCommandLineArguments="--report-trx --results-directory $(Agent.TempDirectory) --coverage"' | |||
| ``` | |||
|
|
|||
| ## Known limitations | |||
|
|
|||
| The MSTest SDK has limited integration with NuGet, meaning that the usual NuGet update and Visual Studio UI for managing NuGet packages **DOES NOT** work as expected. See this issue for more details: [NuGet#13127](https://github.com/NuGet/Home/issues/13127). | |||
There was a problem hiding this comment.
If someone is here viewing this section, which is Known limitations, it's not really beneficial to try and use CAPS to emphasize something that is a known limitation. Someone taking the time to read this paragraph will understand the context. It's not hidden in a sea of paragraphs and tables, it's the first thing mentioned. If anything, I would use this instead:
| The MSTest SDK has limited integration with NuGet, meaning that the usual NuGet update and Visual Studio UI for managing NuGet packages **DOES NOT** work as expected. See this issue for more details: [NuGet#13127](https://github.com/NuGet/Home/issues/13127). | |
| The MSTest SDK has limited integration with NuGet, meaning that the usual NuGet update and Visual Studio UI for managing NuGet packages **doesn't** work as expected. See this issue for more details: [NuGet#13127](https://github.com/NuGet/Home/issues/13127). |
But honestly this isn't very clear about the limitation. As a user, I don't want to have to go click on a link and read through comment-after-comment to understand the limitation. Just tell me the limitation and what I need to do to work around it.
Summary
Fixes microsoft/testfx#4114
Internal previews