Skip to content

Fixes #16176 - replace snippet tag with code tag in comments#16177

Merged
iSazonov merged 1 commit intoPowerShell:masterfrom
sdwheeler:sdw-fix-code-snippets
Oct 8, 2021
Merged

Fixes #16176 - replace snippet tag with code tag in comments#16177
iSazonov merged 1 commit intoPowerShell:masterfrom
sdwheeler:sdw-fix-code-snippets

Conversation

@sdwheeler
Copy link
Copy Markdown
Collaborator

PR Summary

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 added the Review - Needed The PR is being reviewed label Oct 8, 2021
@ghost
Copy link
Copy Markdown

ghost commented Oct 8, 2021

This pull request has been automatically marked as Review Needed because it has been there has not been any activity for 7 days.
Maintainer, please provide feedback and/or mark it as Waiting on Author

@iSazonov
Copy link
Copy Markdown
Collaborator

iSazonov commented Oct 8, 2021

@sdwheeler @adityapatwardhan Ready to merge?

@ghost ghost removed the Review - Needed The PR is being reviewed label Oct 8, 2021
@sdwheeler
Copy link
Copy Markdown
Collaborator Author

This is ready from my end.

@iSazonov iSazonov added the CL-CodeCleanup Indicates that a PR should be marked as a Code Cleanup change in the Change Log label Oct 8, 2021
@iSazonov iSazonov merged commit 41093f6 into PowerShell:master Oct 8, 2021
@iSazonov iSazonov assigned iSazonov and unassigned adityapatwardhan Oct 8, 2021
@iSazonov iSazonov modified the milestones: 7.2.0-preview.10, 7.2.0-rc.1 Oct 8, 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-code-snippets 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-CodeCleanup Indicates that a PR should be marked as a Code Cleanup change in the Change Log

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants