Skip to content

New-MarkdownCommandHelp not including descriptions of INPUTS and OUTPUT from comment-based help #745

Open
@sdwheeler

Description

@sdwheeler

Prerequisites

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

Steps to reproduce

ExampleModule.zip

The attached ZIP file contains the following files:

  • .\ExampleModule.psm1 - a module containing a single function with comment-based help
  • .\test.ps1 - a test script that imports the module and runs New-MarkdownCommandHelp on the function
  • .\docs\ExampleModule\ExampleModule.md - Markdown output
  • .\docs\ExampleModule\Get-ApiApp.md - Markdown output

Unpack the ZIP file and run test.ps1.

Expected behavior

The INPUTS and OUTPUTS section of the markdown file should contain the help text from the comments.


## INPUTS

### System.Int32

The following parameters accept ValueFromPipelineByPropertyName:
- AppId
- AppIds
- PageNumber
- PageSize

### System.Management.Automation.SwitchParameter

The OutputTypeRaw parameter accepts ValueFromPipelineByPropertyName.

## OUTPUTS

### Microsoft.PowerShell.Commands.WebResponseObject

The function returns the results of the API request in a WebResponseObject object by default.

### System.Net.Http.HttpRequestException

The function returns a HttpRequestException object if there is an error in the HTTP request. Typically thrown when an HTTP request fails due to network issues, invalid responses, or other errors related to HTTP communication.

### System.String

If the function is called with -OutputTypeRaw parameter it returns the results of the API request as a JSON formatted string.

Actual behavior

## INPUTS

### System.Int32

{{ Fill in the Description }}

### System.Management.Automation.SwitchParameter

{{ Fill in the Description }}

## OUTPUTS

### Microsoft.PowerShell.Commands.WebResponseObject

{{ Fill in the Description }}

### System.Net.Http.HttpRequestException

{{ Fill in the Description }}

### System.String

{{ Fill in the Description }}

Error details

Environment data

ModuleType Version    PreRelease Name                                ExportedCommands
---------- -------    ---------- ----                                ----------------
Script     1.0.0      preview3   Microsoft.PowerShell.PlatyPS        {Compare-CommandHelp, Export-MamlCommandHelp, Exp…

Visuals

No response

Metadata

Metadata

Labels

BlockedTag - blocked on something external to this repoNeeds-TriageThe issue is new and needs to be triaged by a work group.

Type

No type

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions