Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
LethiferousMoose opened this issue Feb 8, 2022 · 1 comment
Open

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

LethiferousMoose opened this issue Feb 8, 2022 · 1 comment
Labels
Area-Comment-Based-Help Issue deals with conversion of comment-based help Idea-Helpv2

Comments

@LethiferousMoose
Copy link

LethiferousMoose commented 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:

### 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 LethiferousMoose changed the title Documenting Outputs, with descriptions, in Code Documenting Outputs, with Descriptions, in Code Feb 8, 2022
@LethiferousMoose LethiferousMoose changed the title Documenting Outputs, with Descriptions, in Code Documenting Outputs (with Descriptions) in Code Feb 8, 2022
@LethiferousMoose LethiferousMoose changed the title Documenting Outputs (with Descriptions) in Code Documenting Outputs/Inputs (with Descriptions) in Code Feb 8, 2022
@sdwheeler sdwheeler added this to the 2.0-consider milestone Feb 9, 2022
@sdwheeler sdwheeler modified the milestones: 2.0-consider, 2.0-Preview3 Apr 4, 2022
@sdwheeler
Copy link
Collaborator

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

@sdwheeler sdwheeler added Area-Comment-Based-Help Issue deals with conversion of comment-based help and removed Area-Comment-BasedHelp labels Apr 5, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Area-Comment-Based-Help Issue deals with conversion of comment-based help Idea-Helpv2
Projects
None yet
Development

No branches or pull requests

2 participants