Skip to content

Document FUNCTIONALITY, .COMPONENT, & .ROLE sections of comment-based help #3031

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.

Sign up for GitHub

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

Jump to bottom
Closed
joeyaiello opened this issue Oct 15, 2018 · 1 comment · Fixed by #6095
Closed

Document FUNCTIONALITY, .COMPONENT, & .ROLE sections of comment-based help #3031

joeyaiello opened this issue Oct 15, 2018 · 1 comment · Fixed by #6095
Assignees
@sdwheeler
Labels
area-helpsystem Area - Help services (pipeline, get/update-help) Pri3 Priority - Low

Comments

@joeyaiello
Copy link
Contributor

joeyaiello commented Oct 15, 2018 •
edited by sdwheeler
Loading

Docs needed for 'Get-Help and about_Comment_Based_Help

There is no guidance or use cases for filling in the .FUNCTIONALITY, .COMPONENT, & .ROLE sections or use the corresponding Get-Help parameters, nor examples for how to use the parameters'

This issue was generated because an issue in the
PowerShell/PowerShell repository had an issue marked
as Documentation Needed and should instead be tracked here in PowerShell-Docs.

The pull request or issue that contains this is located at PowerShell/PowerShell#7113
@joeyaiello joeyaiello added area-helpsystem Area - Help services (pipeline, get/update-help) Pri3 Priority - Low labels Oct 31, 2018
@joeyaiello
Copy link
Contributor Author

joeyaiello commented Oct 31, 2018 •
edited
Loading

Not sure that anyone knows what these actually do, but it sounds like we should update about_Comment_Based_Help

@sdwheeler sdwheeler mentioned this issue May 22, 2019
Closed
4 tasks
@sdwheeler sdwheeler changed the title Docs needed for 'Get-Help and about_Comment_Based_Help does not provide guidance or use cases for filling in the .FUNCTIONALITY, .COMPONENT, & .ROLE sections or use the corresponding Get-Help parameters, nor examples for how to use the parameters' Document FUNCTIONALITY, .COMPONENT, & .ROLE sections of comment-based help Mar 20, 2020
@sdwheeler sdwheeler self-assigned this Jun 9, 2020
@sdwheeler sdwheeler mentioned this issue Jun 9, 2020
Merged
18 tasks
sdwheeler added a commit that referenced this issue Jun 9, 2020
@sdwheeler
Fixes #3031 - comment-based help (#6095)
08c49d3 
* Fixes #3031 - comment-based help

* feedback
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@sdwheeler sdwheeler

Labels
area-helpsystem Area - Help services (pipeline, get/update-help) Pri3 Priority - Low
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Fixes #3031 - comment-based help
2 participants
@joeyaiello @sdwheeler