Skip to content
This repository has been archived by the owner on Feb 28, 2022. It is now read-only.

use literal scalar style for summary to avoid extra empty newline whi… #19

Merged
merged 2 commits into from
Oct 26, 2018
Merged

use literal scalar style for summary to avoid extra empty newline whi… #19

merged 2 commits into from
Oct 26, 2018

Conversation

v-pegao
Copy link
Collaborator

@v-pegao v-pegao commented Oct 23, 2018

Issue: 45440
Change:

  • Use literal scalar style for summary to avoid extra empty newline which will break html list format

Affect:

  • The extra empty new line in summary will be removed
  • The line break will be format to \n for summary with YamlUtility.Deserialize, but YamlUtility.Serialize still respects the line break of writer
  • Not sure if any other effect exist..

Preview Page

@superyyrrzz
Copy link
Collaborator

Looks like the right place to fix this issue. After some investigation, I think it's like a bug in YamlDotNet, where I created an issue. Using another ScalarStyle is a nice workaround.

One suggestion: what about use ScalarStyle.DoubleQuoted? Feel it's safer, and also already used in .NET reference YAMLs

@v-pegao v-pegao merged commit a7e53d5 into docascode:azuredocs Oct 26, 2018
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants