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 notes and links to rule help #382

Closed
BernieWhite opened this issue Jan 2, 2020 · 0 comments · Fixed by #383
Closed

Add notes and links to rule help #382

BernieWhite opened this issue Jan 2, 2020 · 0 comments · Fixed by #383
Assignees
Labels
enhancement New feature or request
Milestone

Comments

@BernieWhite
Copy link
Member

Currently PSRule help only displays synopsis, description and recommendation sections. Additionally the notes section (previously mentioned in documentation) and a links section should be included.

Recommendations are included in output. When URLs are included this tends to bloat the output unnecessarily.

Additionally, verbose background information and configuration options ideally should not be included in the description or recommendation. Instead use notes.

@BernieWhite BernieWhite added the enhancement New feature or request label Jan 2, 2020
@BernieWhite BernieWhite added this to the v0.13.0 milestone Jan 2, 2020
@BernieWhite BernieWhite self-assigned this Jan 2, 2020
BernieWhite added a commit that referenced this issue Jan 2, 2020
This was referenced Jan 3, 2020
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

Successfully merging a pull request may close this issue.

1 participant