Skip to content

Update-MarkdownCommandHelp does not handle old format #824

@MartinGC94

Description

@MartinGC94

Prerequisites

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

Steps to reproduce

I have markdown files built with/for the old platyPS module version 0.14.2. I tried using Update-MarkdownCommandHelp from Microsoft.PowerShell.PlatyPS version 1.0.1 to update them to the new format and it ended up duplicating the parameter help text.
I don't know if it's supposed to be possible to migrate from the old to new format like this, but if it's not supposed to work maybe it should throw an error or write a warning instead of pretending it's all good?

Here's a snippet of the diff output I'm seeing:

Image

Expected behavior

Either correctly update the format, or notify the user (via warning or error) that the markdown is invalid.

Actual behavior

The command silently completes just like it would on a successful run.

Error details

Environment data

Name                           Value
----                           -----
PSVersion                      7.6.0-preview.4
PSEdition                      Core
GitCommitId                    7.6.0-preview.4
OS                             Microsoft Windows 10.0.26100
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

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions