Repository navigation
Label the permissions in the help, and fail the check on holes - #2
Merged
Merged
Conversation
The permissions were in the .NOTES block under the heading "Required permissions". The standard label is RequiredPermissions, which is what the generator's table renderer keys on, so the site rendered four paragraphs where the credential rotation pages render a table. Relabelled, with the rest of the block given labels of its own rather than being absorbed into the permissions row: Prerequisites, Writes, License. No permission changed; the wording is the same text under headings the tooling understands. The generator gets the same hardening as the skeleton. An empty examples array rendered an empty "### Example 1", an undocumented parameter rendered an empty table cell, and neither failed anything. Both, and a .NOTES block without RequiredPermissions, now fail -Check. A .NOTES block that opens with prose is left as prose rather than losing its first paragraph to the table.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The permissions were in
.NOTESunder the headingRequired permissions. The standard label isRequiredPermissions, which is what the table renderer keys on — so the site rendered four paragraphs where the credential rotation pages render a table.Relabelled, with the rest of the block given its own labels instead of being absorbed into the permissions row:
Prerequisites,Writes,License. No permission changed.The generator gets the same hardening as
powershell-tool-skeleton#3: an empty examples array rendered an empty### Example 1, an undocumented parameter rendered an empty table cell, and neither failed anything. All three now fail-Check. A.NOTESblock that opens with prose is left as prose rather than losing its first paragraph.Verified:
-Checkclean, PSScriptAnalyzer clean.