Change snippet tag to code in /// comments#16106
Merged
daxian-dbw merged 1 commit intoPowerShell:masterfrom Sep 15, 2021
Merged
Change snippet tag to code in /// comments#16106daxian-dbw merged 1 commit intoPowerShell:masterfrom
daxian-dbw merged 1 commit intoPowerShell:masterfrom
Conversation
Member
|
Reassigning as Andrew is still out |
5 tasks
|
🎉 Handy links: |
5 tasks
TrapGodBrim
pushed a commit
to TrapGodBrim/PowerShell
that referenced
this pull request
Jan 19, 2022
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.
PR Summary
Change snippet tag to code in /// comments - Fixes #16104
PR Context
Documentation for the PowerShell SDK is generated from triple-slash comments in the source code. Therefore any changes to that documentation must be made in the source code.
The
<snippet>tag is not supported and is causing rendering issues.PR Checklist
.h,.cpp,.cs,.ps1and.psm1files have the correct copyright headerWIP:or[ WIP ]to the beginning of the title (theWIPbot will keep its status check atPendingwhile the prefix is present) and remove the prefix when the PR is ready.(which runs in a different PS Host).