Skip to content

Microsoft.PowerShell.PlatyPS v1 doesn't contain help files #829

@TMA-2

Description

@TMA-2

Prerequisites

  • Write a descriptive title.
  • Make sure you are able to repro it on the latest version
  • Search the existing issues.

Steps to reproduce

Apologies if this is a duplicate of an existing issue -- I couldn't find an existing one ('help' turns up in most titles given the module's nature...).

Ironically, and unless I'm just addled and looking in the wrong place, Microsoft.PowerShell.PlatyPS does not appear to contain any help documents, whether MAML or otherwise.

I understand running Update-Help -Module Microsoft.PowerShell.PlatyPS pulls it down, but (and this is likely just ignorance on my part) I'm not sure why the module isn't packaged with help files. I assume it's by design, but I'm unsure why.

In all, it's only a minor annoyance to have that extra step. I'm also not sure where the source help files are stored for the new version.

Thanks!

Expected behavior

Install-Module Microsoft.PowerShell.PlatyPS
Get-Help New-CommandHelp

Actual behavior

This is required instead:

Install-Module Microsoft.PowerShell.PlatyPS
Update-Help Microsoft.PowerShell.PlatyPS
Get-Help New-CommandHelp

Error details

NAME
    New-CommandHelp

SYNTAX
    New-CommandHelp [-CommandInfo] <CommandInfo[]> [<CommonParameters>]


ALIASES
    None


REMARKS
    None

Environment data

Name                           Value
----                           -----
PSVersion                      7.5.3
PSEdition                      Core
GitCommitId                    7.5.3
OS                             Microsoft Windows 10.0.22631
Platform                       Win32NT
PSCompatibleVersions           {1.0, 2.0, 3.0, 4.0…}
PSRemotingProtocolVersion      2.3
SerializationVersion           1.1.0.1
WSManStackVersion              3.0

Version

1.0.1

Visuals

No response

Metadata

Metadata

Assignees

No one assigned

    Labels

    Needs-TriageThe issue is new and needs to be triaged by a work group.

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions