psDoc icon indicating copy to clipboard operation
psDoc copied to clipboard

Multi lines examples

Open Abeatbowl opened this issue 6 years ago • 3 comments

Hi,

Is there a way to deal with mulitples lines examples ?

For example, a header like this :

	<# 
	.SYNOPSIS
		Do Something
	.DESCRIPTION
		Do Something
	.PARAMETER Arg1
		Arg1
	.PARAMETER Arg2
		Arg2
	.PARAMETER Arg3
		Arg3
	.INPUTS
	.OUTPUTS
		Renvoit la liste de la ou des archive(s) générée(s)
	.EXAMPLE
		$var = 'Test'
		Do-Something -Arg1 $var
		Invoke the Do-Something cmdlet with the $var variable
	.NOTES
	.LINK
	#>

Looks like this : image

When I would like it to look like this : image

Regards,

Abeatbowl avatar Mar 07 '18 15:03 Abeatbowl

I think it's the powershell help engine problem actually, seen the same in https://github.com/PowerShell/platyPS/issues/180

vors avatar Mar 07 '18 18:03 vors

Indeed it is. I'll try find a workaround. Thanks !

Abeatbowl avatar Mar 14 '18 08:03 Abeatbowl

For a workaround, take a look at https://github.com/PowerShell/platyPS/issues/180#issuecomment-536212832.

Greg-Smulko avatar Sep 28 '19 18:09 Greg-Smulko