Skip to content

Documenting Outputs/Inputs (with Descriptions) in Code #558

Open
@LethiferousMoose

Description

@LethiferousMoose

Steps to reproduce

Create a function with a comment header, and add the .OUTPUTS comment based help keyword. Type in the type and some descriptive text indented on the next line. Without using the MD files as the source of truth I have not found a way to generate what you would type in the markdown file directly. I suspect .INPUTS has a similar problem.

.OUTPUTS
System.IO.FileInfo[]
    This cmdlet returns a FileInfo[] object for created files.

Expected behavior

Generated markdown should look like:

### System.IO.FileInfo[] 
This cmdlet returns a FileInfo[] object for created files.

Actual behavior

### System.IO.FileInfo[]
###     This cmdlet returns a FileInfo[] object for created files.

Environment data

v0.14.2

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions