Skip to content

Update-MarkdownHelp adds and removes blank lines #319

Closed
@BernieWhite

Description

@BernieWhite

Steps to reproduce

  • In an existing cmdlet markdown document add a blank line between ## DESCRIPTION and first line of the description text. e.g.
## DESCRIPTION

Create markdown from an input object.

## EXAMPLES
  • With no defined related links, create a single blank directly after the ## RELATED LINKS section.
## NOTES

## RELATED LINKS

Expected behavior

  • A single blank line created after section headers such as description should be preserved for readability.
  • Multiple sequential blank lines after section headers should be removed/reduced down to one.
  • Blank line should not be added to after section header if it didn't exist before Update-MarkdownHelp was called.
  • No more then a single blank line should be created after the related links section with no related links have been defined.

Actual behavior

  • Blank line is removed.

image

## DESCRIPTION
Create markdown from an input object.

## EXAMPLES
  • Blank line is added.

image

## NOTES

# RELATED LINKS


Environment data

v0.8.3

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions