Skip to content

Change snippet tag to code in /// comments#16106

Merged
daxian-dbw merged 1 commit intoPowerShell:masterfrom
sdwheeler:sdw-fix-snippet-tags
Sep 15, 2021
Merged

Change snippet tag to code in /// comments#16106
daxian-dbw merged 1 commit intoPowerShell:masterfrom
sdwheeler:sdw-fix-snippet-tags

Conversation

@sdwheeler
Copy link
Copy Markdown
Collaborator

@sdwheeler sdwheeler commented Sep 15, 2021

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

@ghost ghost assigned anmenaga Sep 15, 2021
Copy link
Copy Markdown
Member

@SteveL-MSFT SteveL-MSFT left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@SteveL-MSFT SteveL-MSFT assigned daxian-dbw and unassigned anmenaga Sep 15, 2021
@SteveL-MSFT
Copy link
Copy Markdown
Member

Reassigning as Andrew is still out

@daxian-dbw daxian-dbw merged commit 6d2feee into PowerShell:master Sep 15, 2021
@iSazonov iSazonov added the CL-Docs Indicates that a PR should be marked as a documentation change in the Change Log label Sep 16, 2021
@iSazonov iSazonov added this to the 7.2.0-rc.1 milestone Sep 16, 2021
@ghost
Copy link
Copy Markdown

ghost commented Dec 16, 2021

🎉v7.3.0-preview.1 has been released which incorporates this pull request.:tada:

Handy links:

TrapGodBrim pushed a commit to TrapGodBrim/PowerShell that referenced this pull request Jan 19, 2022
@sdwheeler sdwheeler deleted the sdw-fix-snippet-tags branch September 8, 2022 21:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

CL-Docs Indicates that a PR should be marked as a documentation change in the Change Log

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Doc Bug in source - <snippet> tag is not supported by the docs platform

5 participants