HelpOut icon indicating copy to clipboard operation
HelpOut copied to clipboard

`HelpOut` `Get-Help -Online`

Open StartAutomating opened this issue 1 year ago • 2 comments

Fun fact: the first .LINK in a PowerShell function is used for Get-Help -Online.

Since HelpOut helps you generate markdown help, presumably for online scenarios, it should be somewhat straightforward to modify a function so that its first link points to the correct location.

  • [ ] #211
  • [ ] #212

StartAutomating avatar Nov 06 '24 20:11 StartAutomating

Fascinating! Does this override [CmdletBinding(HelpUri = 'https://day3bits.com/PSPreworkout/Edit-PSReadLineHistoryFile')] or does it only take effect if the HelpUri has not been specified?

SamErde avatar Nov 07 '24 21:11 SamErde

@SamErde well, we're talking new functionality here, so, I'm not quite sure yet.

HelpUri isn't required: the first .Link will be counted as Get-Help online. So presumably that would be where it would be inserted.

I was not planning on overriding anything, merely putting it in if it did not exist.

StartAutomating avatar Nov 09 '24 06:11 StartAutomating