Description
The SCCM ConfigrationManager module cmdlets have input and output types with names that contain the #
character.
When those names are rendered on the website, the name is truncated at the #
character. For example, see the output section of the following file https://raw.githubusercontent.com/MicrosoftDocs/sccm-docs-powershell-ref/master/sccm-ps/ConfigurationManager/Add-CMAssetIntelligenceSynchronizationPoint.md
## OUTPUTS
### IResultObject#SMS_SCI_SysResUse
The Maml2Yaml function in PlatyPS does not escape the #
in the middle of the name, which results in the following rendering on https://docs.microsoft.com/en-us/powershell/module/configurationmanager/add-cmassetintelligencesynchronizationpoint?view=sccm-ps#outputs
According to the YAML specification, the #
character is used for comments in YAML.
6.6. Comments
An explicit comment is marked by a “#” indicator. Comments are a presentation detail and must not be used to convey content information.
See https://yaml.org/spec/1.2/spec.html#id2780069
5.7. Escaped Characters
All non-printable characters must be escaped. YAML escape sequences use the “\” notation common to most modern computer languages. Each escape sequence must be parsed into the appropriate Unicode character. The original escape sequence is a presentation detail and must not be used to convey content information.