Get-Help always launches online help if user has the -Online parameter defaulted to $true #1393
Comments
ghost
added
the
deadlydog
added a commit
to deadlydog/PowerShellEditorServices
that referenced
this issue
Nov 24, 2020
If the user has overridden the Get-Help -Online parameter to always be true, then the ShowHelpHandler will always launch a new browser window to the cmdlet help. Instead, we want it to return the full cmdlet text as intended.
deadlydog
added a commit
to deadlydog/PowerShellEditorServices
that referenced
this issue
Nov 25, 2020
If the user has overridden the Get-Help -Online parameter to always be true, then calls to Get-Help will always launch a new browser window to the cmdlet help. Instead, we want it to return the full cmdlet text as intended. fix 1393: Always use local help when retrieving Full help
deadlydog
added a commit
to deadlydog/PowerShellEditorServices
that referenced
this issue
Nov 25, 2020
If the user has overridden the Get-Help -Online parameter to always be true, then calls to Get-Help will always launch a new browser window to the cmdlet help. Instead, we want it to return the full cmdlet text as intended, otherwise things like intellisense and tooltips may end up opening the cmdlet help in a new browser window.
deadlydog
added a commit
to deadlydog/PowerShellEditorServices
that referenced
this issue
Nov 25, 2020
If the user has overridden the Get-Help -Online parameter to always be true, then calls to Get-Help will always launch a new browser window to the cmdlet help. Instead, we want it to return the full cmdlet text as intended, otherwise things like intellisense and tooltips may end up opening the cmdlet help in a new browser window.
TylerLeonhardt
pushed a commit
that referenced
this issue
Dec 1, 2020
If the user has overridden the Get-Help -Online parameter to always be true, then calls to Get-Help will always launch a new browser window to the cmdlet help. Instead, we want it to return the full cmdlet text as intended, otherwise things like intellisense and tooltips may end up opening the cmdlet help in a new browser window.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
I originally posted this bug in the VS Code PowerShell extension GitHub repo, but after digging through the code found that the bug was actually in this repository.
Basically the issue is that if the user has defaulted the
Get-Helpcmdlet's-Onlineparameter to $true, such as by putting this line in their PowerShell Profile:Then
Get-Helpwill always launch a browser window. This causes an issue because VS Code (and other editors) use thegetCommandHelpprovider to provide the text for intellisense and tooltips. So whenever the editor would normally show intellisense or a tooltip, it instead opens a browser window to the online help page of the cmdlet. You can see this demonstrated in this gif.The text was updated successfully, but these errors were encountered: