Generated Docs have disallowed docfx syntax.

[georgend]

According to to DocFx Contributor Guide, the autorest.powershell docs generator is generating content that is considered as disallowed html tags.
Example Build Report:-

For Example:-

Get1

Get-MgDeviceXXXX-OutFile <String>
 -BodyParameter <SomeProperty>
 [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>]

<SomeProperty> is considered a disallowed html tag.
It should be \<SomeProperty\> where the angle brackets are escaped.

The responsible code is located here:-

autorest.powershell/powershell/resources/psruntime/BuildTime/Models/PsProxyOutputs.cs

Line 414 in 36670d7

var type = ParameterType != typeof(SwitchParameter) ? $" <{ParameterType.ToSyntaxTypeName()}>" : String.Empty;

<{ParameterType.ToSyntaxTypeName()}> should be escaped.

[BethanyZhou]

Hi @georgend ,

we follow PowerShell command syntax format to use -BodyParameter <SomeProperty>, please refer to https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/get-command?view=powershell-7.2#syntax. We will embody command syntax with ``` like a code block. Could you skip build for this kind of content?

[georgend]

I understand the PowerShell command syntax format, however the issue is that DocFX is complaining with what is output.

[timayabi2020]

@BethanyZhou i've been following up on this thread and I forked the repo and created a PR #958 to sort out this issue. Kindly have a look at it and let me know if there is anything more that needs to be done.

[BethanyZhou]

Close as PR#958 merged