You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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
The text was updated successfully, but these errors were encountered:
LethiferousMoose
changed the title
Documenting Outputs, with descriptions, in Code
Documenting Outputs, with Descriptions, in Code
Feb 8, 2022
LethiferousMoose
changed the title
Documenting Outputs, with Descriptions, in Code
Documenting Outputs (with Descriptions) in Code
Feb 8, 2022
LethiferousMoose
changed the title
Documenting Outputs (with Descriptions) in Code
Documenting Outputs/Inputs (with Descriptions) in Code
Feb 8, 2022
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:
Actual behavior
Environment data
v0.14.2
The text was updated successfully, but these errors were encountered: