platyPS icon indicating copy to clipboard operation
platyPS copied to clipboard

Documenting Outputs/Inputs (with Descriptions) in Code

Open LethiferousMoose opened this issue 4 years ago • 1 comments

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

LethiferousMoose avatar Feb 08 '22 06:02 LethiferousMoose

Investigate rendering of comment-based help to make sure we can support current partner modules like Az and MSGraph.

sdwheeler avatar Apr 04 '22 17:04 sdwheeler