Use double quotes in YAML if text contains single quote #749
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
This pull request improves YAML handling in related links and adds a new test case and asset for verifying the changes. The most important changes include fixing issues with single quotes in YAML output, adding a test to ensure the fix works as expected, and introducing a new markdown file for testing purposes.
Improvements to YAML handling:
WriteRelatedLinks
insrc/YamlWriter/CommandHelpYamlWriter.cs
to handle single quotes inLinkText
by dynamically choosing between single or double quotes for YAML formatting.Enhancements to test coverage:
test/Pester/ExportYamlCommandHelp.Tests.ps1
to verify that related links' text with single quotes are correctly preserved in the YAML output.New test asset:
test/Pester/assets/Remove-SqlSensitivityClassification.md
, to serve as a test asset for theExport-YamlCommandHelp
functionality. This file includes detailed metadata, syntax, examples, and related links for theRemove-SqlSensitivityClassification
cmdlet.PR Context
Fixes #747