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

Add online help support to keywords #72

Closed
BernieWhite opened this issue Jan 31, 2019 · 0 comments
Closed

Add online help support to keywords #72

BernieWhite opened this issue Jan 31, 2019 · 0 comments
Assignees
Labels
enhancement New feature or request
Milestone

Comments

@BernieWhite
Copy link
Member

When editing .Rule.ps1 files in Visual Studio Code, keywords are imported into session to allow command completion to provide usage information.

Additionally VS Code can read help information and link out to online help with Get Help for Command. Quickly getting access to online help will improve the authoring experience for defining rules.

For this to work for PSRule keywords, comment-based help needs to provide a online link.

For example:

<#
.LINK
https://berniewhite.github.io/PSRule/keywords/PSRule/en-US/about_PSRule_Keywords.html#rule
#>
@BernieWhite BernieWhite added the enhancement New feature or request label Jan 31, 2019
@BernieWhite BernieWhite changed the title Add online hepl support to keywords Add online help support to keywords Jan 31, 2019
@BernieWhite BernieWhite added this to the v0.3.0 milestone Jan 31, 2019
BernieWhite added a commit that referenced this issue Jan 31, 2019
* Add keyword links to online help #72
@BernieWhite BernieWhite self-assigned this Jan 31, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant