Add line breaks in MAML for examples content #770
Merged
Conversation
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
|
/azp run |
|
Azure Pipelines successfully started running 1 pipeline(s). |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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 introduces a workaround to address an issue with line breaks not being preserved in MAML files during export. The changes include modifying the MAML file processing logic, adjusting how example descriptions are handled, and adding a test case to verify the workaround.
Changes to MAML file processing:
src/Command/ExportMamlCommandHelp.cs, updated theEndProcessingmethod to read the generated MAML file, replace a placeholder (<maml:para>__REMOVE_ME_LINE_BREAK__</maml:para>) with a proper line break representation (<maml:para> </maml:para>), and write the updated content back to the file.Changes to example description handling:
src/MamlWriter/MamlHelpers.cs, updated theConvertExamplemethod to add a placeholder (__REMOVE_ME_LINE_BREAK__) for line breaks between example description items, ensuring proper formatting in the MAML output.Test case addition:
test/Pester/ExportMamlCommandHelp.Tests.ps1, added a test to verify that the exported MAML file contains the correct line break workaround (<maml:para> </maml:para>).PR Context
Fixes #754