Skip to content

PlatyPS: INPUTS/OUTPUTS from comment-based help always get a {{ Fill in the Description }} placeholder #249

Description

@bravo-kernel

Tracks an upstream PlatyPS bug we currently shim around. Context: #241 (v2 migration).

Problem

For comment-based help, Export-MarkdownCommandHelp always appends a {{ Fill in the Description }} placeholder to INPUTS/OUTPUTS entries — even when the help block does describe the type. Get-Help returns the entire .INPUTS/.OUTPUTS block as the type name, so the description field PlatyPS inspects is always empty. Related quirk: the type line is comma-split as a type list, silently truncating descriptions that contain a comma.

Our mitigation

Source/Private/RemoveSectionPlaceholders.ps1 strips the placeholder lines from the generated markdown.

Upstream

  • UPSTREAM-ISSUE-URL

Retire when

An upstream fix ships in a PlatyPS release newer than our RequiredModules pin (currently 1.0.2): bump the pin — the golden fixtures will show exactly when RemoveSectionPlaceholders becomes a no-op for INPUTS/OUTPUTS — then remove that part of the shim and regenerate fixtures.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    externalExternal Dependency

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions