change splatting to remove <br> from docs

[jpomfret]

Type of Change

• Bug fix (non-breaking change, fixes # )
• New feature (non-breaking change, adds functionality, fixes # )
• Breaking change (affects multiple commands or functionality, fixes # )
• Ran manual Pester test and has passed (.\tests\manual.pester.ps1)
• Adding code coverage to existing functionality
• Pester test is included
• If new file reference added for test, has is been added to github.com/dataplat/appveyor-lab ?
• Unit test is included
• Documentation
• Build system

Purpose

The docs on the website have <br> at the end of each row currently from splatting

@niphlod - is there any other options? or is this the fix? Got this from looking at other commands where it works

If this is the fix - I have some more to fix before this PR gets merged... so marking as draft for now

[niphlod]

hi @jpomfret , there's a whole logic behind doc generation but can be replicated locally. If you give me a specific page we can see if it's a problem on the "generation" or on the "display" side of things

edit: that being said you got the gist. Right now multiline examples should be prefixed by either PS C:\> or >> . We could change it but it needs proper testing to avoid breaking other pages.

For the curious enough, logic is in here https://github.com/dataplat/docs/blob/master/assets/templates/to_md.ps1, it turns the json help into markdown pages.

[jpomfret]

This is an example: https://docs.dbatools.io/New-DbaReplCreationScriptOptions.

I will check out that logic and test locally, and then upload the rest of the changes here. Thanks!

[potatoqualitee]

MERCi