Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Help output inconsistent after topic search. #17079

Open
5 tasks done
powercode opened this issue Mar 29, 2022 · 2 comments
Open
5 tasks done

Help output inconsistent after topic search. #17079

powercode opened this issue Mar 29, 2022 · 2 comments
Labels
Issue-Bug Issue has been identified as a bug in the product Up-for-Grabs Up-for-grabs issues are not high priorities, and may be opportunities for external contributors WG-Interactive-HelpSystem help infrastructure and formatting of help

Comments

@powercode
Copy link
Collaborator

powercode commented Mar 29, 2022

Prerequisites

Steps to reproduce

help about_Run_With_PowerShell
help Run
help about_Run_With_PowerShell

After having run get-help with a name that is a partial match of a help topic, that help is outputted as a HelpInfoShort#FullView (a string with attached note properties).
This is formatted as a table, instead of as a string.
There does not seem to be a formatter registered for HelpInfoShort#FullView or HelpInfoShort.

It is possible to view the help topic by just piping to | % tostring but the user experience is not ideal.

Expected behavior

ABOUT_RUN_WITH_POWERSHELL
Short description
...
Name                              Category  Module                    Synopsis
----                              --------  ------                    --------
runtests.ps1                      External…                           runtests.ps1 [-TntRoot] <string> [[-FrostShellRoot] <string>] [<CommonParameters>]…
Debug-Runspace                    Cmdlet    Microsoft.PowerShell.Uti… Starts an interactive debugging session with a runspace.
Disable-RunspaceDebug             Cmdlet    Microsoft.PowerShell.Uti… Disables debugging on one or more runspaces, and releases any pending debugger stop.
Enable-RunspaceDebug              Cmdlet    Microsoft.PowerShell.Uti… Enables debugging on runspaces where any breakpoint is preserved until a debugger is attached.
Get-Runspace                      Cmdlet    Microsoft.PowerShell.Uti… Gets active runspaces within a PowerShell host process.
Get-RunspaceDebug                 Cmdlet    Microsoft.PowerShell.Uti… Shows runspace debugging options.
about_Run_With_PowerShell         HelpFile
ABOUT_RUN_WITH_POWERSHELL
Short description
...

Actual behavior

ABOUT_RUN_WITH_POWERSHELL
Short description
...
Name                              Category  Module                    Synopsis
----                              --------  ------                    --------
runtests.ps1                      External…                           runtests.ps1 [-TntRoot] <string> [[-FrostShellRoot] <string>] [<CommonParameters>]…
Debug-Runspace                    Cmdlet    Microsoft.PowerShell.Uti… Starts an interactive debugging session with a runspace.
Disable-RunspaceDebug             Cmdlet    Microsoft.PowerShell.Uti… Disables debugging on one or more runspaces, and releases any pending debugger stop.
Enable-RunspaceDebug              Cmdlet    Microsoft.PowerShell.Uti… Enables debugging on runspaces where any breakpoint is preserved until a debugger is attached.
Get-Runspace                      Cmdlet    Microsoft.PowerShell.Uti… Gets active runspaces within a PowerShell host process.
Get-RunspaceDebug                 Cmdlet    Microsoft.PowerShell.Uti… Shows runspace debugging options.
about_Run_With_PowerShell         HelpFile
Name                              Category  Module                    Synopsis
----                              --------  ------                    --------
about_Run_With_PowerShell         HelpFile

Error details

No response

Environment data

Name                           Value
----                           -----
PSVersion                      7.3.0-preview.3
PSEdition                      Core
GitCommitId                    7.3.0-preview.3-22-g93a0f9b8dc4149fb8ac65a3e6fa47faff099091e
OS                             Microsoft Windows 10.0.19044
Platform                       Win32NT
PSCompatibleVersions           {1.0, 2.0, 3.0, 4.0…}
PSRemotingProtocolVersion      2.3
SerializationVersion           1.1.0.1
WSManStackVersion              3.0

Visuals

No response

@powercode powercode added the Needs-Triage The issue is new and needs to be triaged by a work group. label Mar 29, 2022
@iSazonov iSazonov added the WG-Interactive-HelpSystem help infrastructure and formatting of help label Mar 30, 2022
@theJasonHelmick
Copy link
Collaborator

This behavior also happens with Get-Help, so I don't think the function help is the culprit.

@theJasonHelmick
Copy link
Collaborator

Thank you @powercode for this issue. The working Group has reviewed this and agrees that it is a bug. We will open this to the community and look forward to a PR.

@theJasonHelmick theJasonHelmick added Issue-Bug Issue has been identified as a bug in the product Up-for-Grabs Up-for-grabs issues are not high priorities, and may be opportunities for external contributors and removed Needs-Triage The issue is new and needs to be triaged by a work group. labels Nov 29, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Issue-Bug Issue has been identified as a bug in the product Up-for-Grabs Up-for-grabs issues are not high priorities, and may be opportunities for external contributors WG-Interactive-HelpSystem help infrastructure and formatting of help
Projects
None yet
Development

No branches or pull requests

3 participants