Documentation for the PowerShell SDK is generated from triple-slash comments in the source code. Therefore any changes to that documentation must be made in the source code.
C:\Git\PS-Src\PowerShell\src\System.Management.Automation\engine\cmdlet.cs
804,17: /// <snippet Code="C#">
900,17: /// <snippet Code="C#">
1004,17: /// <snippet Code="C#">
1120,17: /// <snippet Code="C#">
1236,17: /// <snippet Code="C#">
1365,17: /// <snippet Code="C#">
1505,17: /// <snippet Code="C#">
C:\Git\PS-Src\PowerShell\src\System.Management.Automation\engine\MshCommandRuntime.cs
1066,17: /// <snippet Code="C#">
1160,17: /// <snippet Code="C#">
1263,17: /// <snippet Code="C#">
1378,17: /// <snippet Code="C#">
1684,17: /// <snippet Code="C#">
1866,17: /// <snippet Code="C#">
C:\Git\PS-Src\PowerShell\src\System.Management.Automation\engine\hostifaces\MshHostRawUserInterface.cs
1461,17: /// <snippet Code="C#">
Here is a screenshot of the rendering issue.
Prerequisites
Steps to reproduce
Documentation for the PowerShell SDK is generated from triple-slash comments in the source code. Therefore any changes to that documentation must be made in the source code.
The following files use the
<snippet>tag in the comments. This tag is not supported and is causing rendering issues.See the Examples section of https://docs.microsoft.com/en-us/dotnet/api/system.management.automation.cmdlet.shouldprocess?view=powershellsdk-7.0.0#System_Management_Automation_Cmdlet_ShouldProcess_System_String_ to see the rendering issue.
You must use the
<code>tag instead.Expected behavior
n/aActual behavior
n/aError details
No response
Environment data
n/aVisuals
Here is a screenshot of the rendering issue.