Skip to content

Synopsis set to placeholder when description is missing #860

Description

@fflaten

Prerequisites

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

Steps to reproduce

Issue - synopsis without description:

function Synopsis {
<#
.SYNOPSIS
demo
#>
param()
}

(Get-help Synopsis).Synopsis
demo
(New-CommandHelp (Get-Command Synopsis)).Synopsis
{{ Fill in the Synopsis }}

With description:

function SynopsisAndDesc {
<#
.SYNOPSIS
demo
.DESCRIPTION
demo desc
#>
param()
}

(Get-help SynopsisAndDesc).Synopsis
demo
(New-CommandHelp (Get-Command SynopsisAndDesc)).Synopsis
demo

Expected behavior

(Get-help Synopsis).Synopsis
demo
(New-CommandHelp (Get-Command Synopsis)).Synopsis
demo

Actual behavior

(Get-help Synopsis).Synopsis
demo
(New-CommandHelp (Get-Command Synopsis)).Synopsis
{{ Fill in the Synopsis }}

Error details

Environment data

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

Version

1.0.3

Visuals

No response

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