Skip to content

Commit 42aec4a

Browse files
ghogenv-andreaco
andauthored
Fix validation issues in VS docs (#8546)
* validation issues in vs docs * Update docs/test/live-unit-testing-faq.yml * Update docs/test/live-unit-testing-faq.yml Co-authored-by: Andrea Courtright <[email protected]>
1 parent dc17543 commit 42aec4a

22 files changed

+31
-25
lines changed

docs/code-quality/ca0070.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
title: CA0070
3+
description: "This error occurs when code analysis analyzes an assembly and encounters permission attributes and certain conditions are true."
34
ms.date: 10/19/2016
45
ms.topic: reference
56
f1_keywords:

docs/code-quality/fxcop-unported-rules.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
title: Unported rules
3+
description: "Learn about FxCop legacy analysis rules that haven't been implemented as Roslyn analyzers."
34
ms.date: 05/21/2019
45
ms.topic: reference
56
helpviewer_keywords:

docs/debugger/configure-the-windows-firewall-for-remote-debugging.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ Visual Studio and the remote debugger try to open the correct ports during insta
4747

4848
**To open a port using PowerShell:**
4949

50-
For Windows Firewall, you can use PowerShell commands such as [New-NetFirewallRule](/powershell/module/netsecurity/new-netfirewallrule?view=win10-ps).
50+
For Windows Firewall, you can use PowerShell commands such as [New-NetFirewallRule](/powershell/module/netsecurity/new-netfirewallrule).
5151

5252
The following example opens port 4024 for the remote debugger on the remote computer. The path you need to use may be different.
5353

docs/debugger/debug-interface-access/idiasymbol-findsymbolsforacceleratorpointertag.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
description: "Returns the number of accelerator pointer tags in a C++ AMP stub function."
2+
description: "Given a corresponding tag value, this method returns an enumeration of symbols that are contained in this stub function."
33
title: "IDiaSymbol::findSymbolsForAcceleratorPointerTag | Microsoft Docs"
44
ms.date: "11/04/2016"
55
ms.topic: "reference"
@@ -14,7 +14,8 @@ ms.workload:
1414
- "multiple"
1515
---
1616
# IDiaSymbol::findSymbolsForAcceleratorPointerTag
17-
Returns the number of accelerator pointer tags in a C++ AMP stub function.
17+
18+
Given a corresponding tag value, this method returns an enumeration of symbols that are contained in this stub function.
1819

1920
## Syntax
2021

docs/debugger/debug-interface-access/idiasymbol-get-basetype.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
2-
title: "IDiaSymbol::get_baseType | Microsoft Docs"
2+
title: "IDiaSymbol::get_baseType"
3+
description: "Retrieves the base type for this symbol"
34
ms.date: "11/04/2016"
45
ms.topic: "reference"
56
dev_langs:
@@ -15,7 +16,7 @@ ms.workload:
1516
- "multiple"
1617
---
1718
# IDiaSymbol::get_baseType
18-
Retrieves the base type for this symbol<em>.</em>
19+
Retrieves the base type for this symbol.
1920

2021
## Syntax
2122

docs/deployment/how-to-create-a-localized-bootstrapper-package.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ After you create a bootstrapper package, you can create localized versions of th
8888
6. Save the *package.xml* file.
8989

9090
>[!NOTE]
91-
> Starting with the Visual Studio 2019 Update 7 release bootstrapper packages will also be discovered under the path *<VS Install Path>\MSBuild\Microsoft\VisualStudio\BootstrapperPackages*.
91+
> Starting with the Visual Studio 2019 Update 7 release bootstrapper packages will also be discovered under the path *{VS Install Path}\MSBuild\Microsoft\VisualStudio\BootstrapperPackages*.
9292
9393
## See also
9494
- [Create bootstrapper packages](../deployment/creating-bootstrapper-packages.md)

docs/get-started/csharp/tutorial-aspnet-core.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -352,7 +352,7 @@ Here's a quick FAQ to highlight some key concepts.
352352

353353
### What is C#?
354354

355-
[C#](https://docs.microsoft.com/dotnet/csharp/tour-of-csharp/) is a type-safe and object-oriented programming language that's designed to be both robust and easy to learn.
355+
[C#](/dotnet/csharp/tour-of-csharp/) is a type-safe and object-oriented programming language that's designed to be both robust and easy to learn.
356356

357357
### What is ASP.NET Core?
358358

docs/ide/how-to-view-save-and-configure-build-log-files.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ If you build any kind of project by using MSBuild, you can create a log file to
2626

2727
## To view the build log file for a C++ project
2828

29-
1. In **Windows Explorer** or **File Explorer**, open the following file (relative to the project root folder): *Release*\\<ProjectName>\>.Log* or *Debug\\<ProjectName\>.log*
29+
1. In **Windows Explorer** or **File Explorer**, open the following file (relative to the project root folder): *Release*\\{ProjectName}.Log* or *Debug\\{ProjectName}.log*
3030

3131
## To create a build log file for a managed-code project
3232

docs/ide/quickstart-fsharp.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@ description: "Learn how to create an ASP.NET Core web service in Visual Studio w
44
ms.date: 08/24/2018
55
ms.topic: quickstart
66
ms.custom: vs-acquisition
7-
author: "cartermp"
8-
ms.author: "phcart"
7+
author: anandmeg
8+
ms.author: meghaanand
99
manager: jmartens
1010
ms.technology: vs-ide-general
1111
dev_langs:

docs/ide/reference/use-pattern-matching.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ This refactoring applies to:
2020

2121
**What:** Use pattern matching.
2222

23-
**When:** You want to use the new [C# pattern matching](https://docs.microsoft.com/dotnet/csharp/whats-new/csharp-9#pattern-matching-enhancements) capabilities.
23+
**When:** You want to use the new [C# pattern matching](/dotnet/csharp/whats-new/csharp-9#pattern-matching-enhancements) capabilities.
2424

2525
**Why:** This refactoring will make your code more clear and concise.
2626

docs/install/visual-studio-enterprise-guide.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ If you’re looking to save time while you're getting your company running on Vi
2323
## Get started
2424
Learn how to deploy Visual Studio to your enterprise in networked and offline environments.
2525

26-
- **[Enabling Administrator Updates using Microsoft Endpoint Configuration Manager (SCCM)](enabling-administrator-updates.md)**. Visual Studio updates are included in the [Microsoft Update Catalog](https://www.catalog.update.microsoft.com/Home.aspx) and the [Windows Server Update Services (WSUS)](https://docs.microsoft.com/windows-server/administration/windows-server-update-services/get-started/windows-server-update-services-wsus). Enterprise administrators can then download the update and distribute it to Visual Studio client machines across the organization using standard deployment tools such as Microsoft Endpoint Configuration Manager (SCCM).
26+
- **[Enabling Administrator Updates using Microsoft Endpoint Configuration Manager (SCCM)](enabling-administrator-updates.md)**. Visual Studio updates are included in the [Microsoft Update Catalog](https://www.catalog.update.microsoft.com/Home.aspx) and the [Windows Server Update Services (WSUS)](/windows-server/administration/windows-server-update-services/get-started/windows-server-update-services-wsus). Enterprise administrators can then download the update and distribute it to Visual Studio client machines across the organization using standard deployment tools such as Microsoft Endpoint Configuration Manager (SCCM).
2727

2828
- **Understand options for enterprise deployment in networked environments**. The [Visual Studio administrator guide](visual-studio-administrator-guide.md) provides scenario-based guidance for system administrators.
2929

docs/javascript/compile-typescript-code-nuget.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -152,7 +152,7 @@ For instructions to run the app after you compile it, see [Create your first Nod
152152

153153
### Remove default imports
154154

155-
In older ASP.NET Core projects that use the [non-SDK-style format](https://docs.microsoft.com/nuget/resources/check-project-format), you may need to remove some project file elements.
155+
In older ASP.NET Core projects that use the [non-SDK-style format](/nuget/resources/check-project-format), you may need to remove some project file elements.
156156

157157
If you are using the NuGet package for MSBuild support for a project, the project file must not import `Microsoft.TypeScript.Default.props` or `Microsoft.TypeScript.targets`. The files get imported by the NuGet package, so including them separately may cause unintended behavior.
158158

docs/msbuild/customize-your-build.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -239,9 +239,11 @@ But, you can use the following properties to specify *.props* file(s) to be auto
239239

240240
To customize the default values of properties for all C++ builds, create another *.props* file (say, *MyProps.props*), and define the `ForceImportAfterCppProps` property in `Directory.Build.props` pointing to it:
241241

242+
```xml
242243
<PropertyGroup>
243244
<ForceImportAfterCppProps>$(MsbuildThisFileDirectory)\MyProps.props<ForceImportAfterCppProps>
244245
</PropertyGroup>
246+
```
245247

246248
*MyProps.props* will be automatically imported at the very end of *Microsoft.Cpp.props*.
247249

docs/msbuild/errors/msb3821.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,9 +22,9 @@ ms.workload:
2222

2323
This error occurs when MSBuild attempts to process a file downloaded from the web with security restrictions.
2424

25-
When you download web assets such as HTML pages to a Windows device using a browser, the browser inserts a marker called the *mark of the web*, which records the security zone of the site from which the page originated. This is intended to protect from potentially malicious pages and enforce the security level on the original site, even after a page from the site is downloaded. This security check is required due to this security issue: [Visual Studio Remote Code Execution Vulnerability CVE-2018-8172](https://msrc.microsoft.com/update-guide/en-US/vulnerability/CVE-2018-8172).
25+
When you download web assets such as HTML pages to a Windows device using a browser, the browser inserts a marker called the *mark of the web*, which records the security zone of the site from which the page originated. This is intended to protect from potentially malicious pages and enforce the security level on the original site, even after a page from the site is downloaded. This security check is required due to this security issue: [Visual Studio Remote Code Execution Vulnerability CVE-2018-8172](https://msrc.microsoft.com/update-guide/vulnerability/CVE-2018-8172).
2626

27-
MSBuild respects this security restriction, but if you decide that you trust the content in question, but you can override the restriction by unblocking a single file from File Explorer (open the **Properties** window on the file, and check **Unblock**). To unblock multiple files using a PowerShell script, use the [Unblock-File](https://docs.microsoft.com/powershell/module/microsoft.powershell.utility/unblock-file) cmdlet.
27+
MSBuild respects this security restriction, but if you decide that you trust the content in question, but you can override the restriction by unblocking a single file from File Explorer (open the **Properties** window on the file, and check **Unblock**). To unblock multiple files using a PowerShell script, use the [Unblock-File](/powershell/module/microsoft.powershell.utility/unblock-file) cmdlet.
2828

2929
The full message is similar to the following:
3030

docs/msbuild/errors/msb4166.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,6 @@ MSB4166: Child node 'node' exited prematurely. Shutting down. Diagnostic
2626

2727
The error text shown is followed by the exception text, if any.
2828

29-
MSBuild can use multiple processes and there's a scheduler process that distributes work to the various worker nodes. If the worker process crashes without reporting an error to the scheduler, then the scheduler emits this error. Check the error log in the temporary files folder in *MSBuild_<guid>.failure.txt*.
29+
MSBuild can use multiple processes and there's a scheduler process that distributes work to the various worker nodes. If the worker process crashes without reporting an error to the scheduler, then the scheduler emits this error. Check the error log in the temporary files folder in *MSBuild_{guid}.failure.txt*.
3030

3131
This error usually indicates an MSBuild issue, and should be reported to Microsoft. Please report the issue in the [MSBuild GitHub repository](https://github.com/Microsoft/msbuild) or at [Developer Community](https://developercommunity.visualstudio.com/search?space=8).

docs/profiling/analyze-database.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ ms.workload:
1717
Use the Database tool to record the database queries that your app makes during a diagnostic session. You can then analyze information about individual queries to find places to improve your app's performance.
1818

1919
> [!NOTE]
20-
> The Database tool requires Visual Studio 2019 version 16.3 or later and a .NET Core project on Windows using either [ADO.NET]( https://docs.microsoft.com/dotnet/framework/data/adonet/ado-net-overview) or [Entity Framework Core](/ef/core/).
20+
> The Database tool requires Visual Studio 2019 version 16.3 or later and a .NET Core project on Windows using either [ADO.NET](/dotnet/framework/data/adonet/ado-net-overview) or [Entity Framework Core](/ef/core/).
2121
2222
## Setup
2323

docs/profiling/how-to-specify-symbol-file-locations-from-the-command-line.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,9 +43,9 @@ To display symbol information such as function names and line numbers, the VSPer
4343

4444
2. Use the following syntax to set the **_NT_SYMBOL_PATH** environment variable or the VSPerfReport /SymbolPath option:
4545

46-
`srv*<LocalStore>*https://msdl.microsoft.com/download/symbols`
46+
`srv*{LocalStore}*https://msdl.microsoft.com/download/symbols`
4747

48-
where *<LocalStore>* is the path of the local directory that you created.
48+
where *{LocalStore}* is the path of the local directory that you created.
4949

5050
## Specify component symbol files
5151
Profiling Tools searches for the.*pdb* files of the components that you want to profile in their original locations that are stored in the components or in the folder that contains the profiling data file. You can specify other locations to search by adding one or more paths to **_NT_SYMBOL_PATH** or to the **/SymbolPath** option. Separate paths with semi-colons.

docs/sharepoint/walkthrough-creating-a-custom-action-project-item-with-an-item-template-part-1.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -425,7 +425,7 @@ ms.workload:
425425
> [!NOTE]
426426
> If the **Script Debugging Disabled** dialog box appears, choose the **Yes** button to continue to debug the project.
427427

428-
4. On the **Site Actions** menu, choose **SharePoint Developer Center**, verify that the browser opens the website https://docs.microsoft.com/sharepoint/dev/, and then close the web browser.
428+
4. On the **Site Actions** menu, choose **SharePoint Developer Center**, verify that the browser opens the website `https://docs.microsoft.com/sharepoint/dev/`, and then close the web browser.
429429

430430
## Clean up the development computer
431431
After you finish testing the project item, remove the project item template from the experimental instance of Visual Studio.

docs/sharepoint/walkthrough-creating-a-custom-action-project-item-with-an-item-template-part-2.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -301,7 +301,7 @@ ms.workload:
301301

302302
13. In the **Description** box, enter **Opens the SharePoint Developer Center website**.
303303

304-
14. In the **URL** box, enter **https://docs.microsoft.com/sharepoint/dev/**, and then choose the **Finish** button.
304+
14. In the **URL** box, enter `https://docs.microsoft.com/sharepoint/dev/`, and then choose the **Finish** button.
305305

306306
Visual Studio adds an item that's named **CustomAction1** to your project and opens the *Elements.xml* file in the editor. Verify that *Elements.xml* contains the values that you specified in the wizard.
307307

@@ -322,7 +322,7 @@ ms.workload:
322322

323323
The **List Settings** page appears.
324324

325-
4. Under the **Communications** heading near the top of the page, choose the **SharePoint Developer Center** link, verify that the browser opens the website https://docs.microsoft.com/sharepoint/dev/, and then close the browser.
325+
4. Under the **Communications** heading near the top of the page, choose the **SharePoint Developer Center** link, verify that the browser opens the website `https://docs.microsoft.com/sharepoint/dev/`, and then close the browser.
326326

327327
## Cleaning up the development computer
328328
After you finish testing the project item, remove the project item template from the experimental instance of Visual Studio.

docs/test/live-unit-testing-faq.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@ sections:
108108
109109
During build, Live Unit Testing automatically overrides the `<BaseOutputPath>`/`<BaseIntermediateOutputPath>` variables to target the Live Unit Testing artifacts folder.
110110
111-
For example, if your build overrides the <OutputPath> as shown below:
111+
For example, if your build overrides the `<OutputPath>` as shown below:
112112
113113
```xml
114114
<Project>

docs/vsto/create-vsto-add-ins-for-office-by-using-visual-studio.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ ms.workload:
1717
---
1818
# Create VSTO Add-ins for Office by using Visual Studio
1919
> [!IMPORTANT]
20-
> VSTO relies on the [.NET Framework](https://docs.microsoft.com/dotnet/framework/get-started/overview). COM add-ins can also be written with the .NET Framework. Office Add-ins cannot be created with [.NET Core and .NET 5+](https://docs.microsoft.com/dotnet/core/dotnet-five), the latest versions of .NET. This is because .NET Core/.NET 5+ cannot work together with .NET Framework in the same process and may lead to add-in load failures. You can continue to use .NET Framework to write VSTO and COM add-ins for Office. Microsoft will not be updating VSTO or the COM add-in platform to use .NET Core or .NET 5+. You can take advantage of .NET Core and .NET 5+, including ASP.NET Core, to create the server side of [Office Web Add-ins](https://docs.microsoft.com/office/dev/add-ins/overview/office-add-ins).
20+
> VSTO relies on the [.NET Framework](/dotnet/framework/get-started/overview). COM add-ins can also be written with the .NET Framework. Office Add-ins cannot be created with [.NET Core and .NET 5+](/dotnet/core/dotnet-five), the latest versions of .NET. This is because .NET Core/.NET 5+ cannot work together with .NET Framework in the same process and may lead to add-in load failures. You can continue to use .NET Framework to write VSTO and COM add-ins for Office. Microsoft will not be updating VSTO or the COM add-in platform to use .NET Core or .NET 5+. You can take advantage of .NET Core and .NET 5+, including ASP.NET Core, to create the server side of [Office Web Add-ins](/office/dev/add-ins/overview/office-add-ins).
2121
2222
You can use the Microsoft Office developer tools in Visual Studio to create .NET Framework applications that extend Office. These applications are also named *Office solutions*.
2323

docs/vsto/getting-started-programming-vsto-add-ins.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ ms.workload:
2121
---
2222
# Get started programming VSTO Add-ins
2323
> [!IMPORTANT]
24-
> VSTO relies on the [.NET Framework](https://docs.microsoft.com/dotnet/framework/get-started/overview). COM add-ins can also be written with the .NET Framework. Office Add-ins cannot be created with [.NET Core and .NET 5+](https://docs.microsoft.com/dotnet/core/dotnet-five), the latest versions of .NET. This is because .NET Core/.NET 5+ cannot work together with .NET Framework in the same process and may lead to add-in load failures. You can continue to use .NET Framework to write VSTO and COM add-ins for Office. Microsoft will not be updating VSTO or the COM add-in platform to use .NET Core or .NET 5+. You can take advantage of .NET Core and .NET 5+, including ASP.NET Core, to create the server side of [Office Web Add-ins](https://docs.microsoft.com/office/dev/add-ins/overview/office-add-ins).
24+
> VSTO relies on the [.NET Framework](/dotnet/framework/get-started/overview). COM add-ins can also be written with the .NET Framework. Office Add-ins cannot be created with [.NET Core and .NET 5+](/dotnet/core/dotnet-five), the latest versions of .NET. This is because .NET Core/.NET 5+ cannot work together with .NET Framework in the same process and may lead to add-in load failures. You can continue to use .NET Framework to write VSTO and COM add-ins for Office. Microsoft will not be updating VSTO or the COM add-in platform to use .NET Core or .NET 5+. You can take advantage of .NET Core and .NET 5+, including ASP.NET Core, to create the server side of [Office Web Add-ins](/office/dev/add-ins/overview/office-add-ins).
2525
2626
You can use VSTO Add-ins to automate Microsoft Office applications, extend features of the application, and customize the user interface (UI) of the application. For information about how VSTO Add-ins compare to other types of Office solutions you can create by using Visual Studio, see [Office solutions development overview &#40;VSTO&#41;](../vsto/office-solutions-development-overview-vsto.md).
2727

0 commit comments

Comments
 (0)