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

Get-Help Path parameter does not return provider help #19300

Closed
5 tasks done
ThomasNieto opened this issue Mar 9, 2023 · 3 comments
Closed
5 tasks done

Get-Help Path parameter does not return provider help #19300

ThomasNieto opened this issue Mar 9, 2023 · 3 comments
Labels
Resolution-External The issue is caused by external component(s). WG-Interactive-HelpSystem help infrastructure and formatting of help
Milestone

Comments

@ThomasNieto
Copy link
Contributor

Prerequisites

Steps to reproduce

If you look at the example 11 in Get-Help you'll notice that the Path parameter should change the help data returned to be specific about the provider.

Expected behavior

Get-Help Get-Item -Path SQLSERVER:\DataCollection

NAME

    Get-Item

SYNOPSIS

    Gets a collection of Server objects for the local computer and any computers

    to which you have made a SQL Server PowerShell connection.
    ...

Set-Location SQLSERVER:\DataCollection
SQLSERVER:\DataCollection> Get-Help Get-Item

NAME

    Get-Item

SYNOPSIS

    Gets a collection of Server objects for the local computer and any computers

    to which you have made a SQL Server PowerShell connection.
    ...

Actual behavior

Get-Help Get-Item -Path SQLSERVER:\DataCollection

NAME
    Get-Item

SYNOPSIS
    Gets the item at the specified location.


SYNTAX
    Get-Item [-Credential <System.Management.Automation.PSCredential>] [-Exclude <System.String[]>] [-Filter
    <System.String>] [-Force] [-Include <System.String[]>] -LiteralPath <System.String[]> [-Stream <System.String[]>]
    [<CommonParameters>]

    Get-Item [-Path] <System.String[]> [-Credential <System.Management.Automation.PSCredential>] [-Exclude
    <System.String[]>] [-Filter <System.String>] [-Force] [-Include <System.String[]>] [-Stream <System.String[]>]
    [<CommonParameters>]


DESCRIPTION
    The `Get-Item` cmdlet gets the item at the specified location. It doesn't get the contents of the item at the
    location unless you use a wildcard character (`*`) to request all the contents of the item.

    This cmdlet is used by PowerShell providers to navigate through different types of data stores.

Error details

No response

Environment data

Name                           Value
----                           -----
PSVersion                      7.4.0-preview.1
PSEdition                      Core
GitCommitId                    7.4.0-preview.1
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

@ThomasNieto ThomasNieto added the Needs-Triage The issue is new and needs to be triaged by a work group. label Mar 9, 2023
@kilasuit kilasuit added the WG-Interactive-HelpSystem help infrastructure and formatting of help label Mar 9, 2023
@sdwheeler
Copy link
Collaborator

Provider help does not work because we are no longer publishing help for providers in MAML format. The documentation build pipeline doesn't support creation of provider help. It's not likely that we will support provider help anytime soon.

@sdwheeler sdwheeler added Resolution-By Design The reported behavior is by design. and removed Needs-Triage The issue is new and needs to be triaged by a work group. labels Jun 21, 2023
@sdwheeler
Copy link
Collaborator

sdwheeler commented Jun 21, 2023

We look to improve the documentation pipeline in the future. We will revisit this in the future.

@sdwheeler sdwheeler added Resolution-External The issue is caused by external component(s). and removed Resolution-By Design The reported behavior is by design. labels Jun 21, 2023
@sdwheeler sdwheeler added this to the Future milestone Jun 21, 2023
@ghost
Copy link

ghost commented Jun 22, 2023

This issue has been marked as external and has not had any activity for 1 day. It has been be closed for housekeeping purposes.

@ghost ghost closed this as completed Jun 22, 2023
This issue was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Resolution-External The issue is caused by external component(s). WG-Interactive-HelpSystem help infrastructure and formatting of help
Projects
None yet
Development

No branches or pull requests

3 participants