Preserve blank lines in endpoint descriptions#1068
Merged
Conversation
Contributor
Author
|
Tagging you @sunshowers for fun since we just talked about an unrelated doc comment parsing issue here. |
3 tasks
Contributor
Author
|
I regenerated the Nexus OpenAPI JSON using this code and confirmed the comment I added in oxidecomputer/omicron#5914 is the only one affected by this change. |
sunshowers
reviewed
Jul 25, 2024
sunshowers
approved these changes
Jul 25, 2024
sunshowers
left a comment
Contributor
There was a problem hiding this comment.
Looks good to me! Though I'm not sure if Adam or Dave also want to have a look at it.
Contributor
Author
|
Considering the effect in Nexus is so limited, I’m just gonna go for it. |
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
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.
Currently we turn blank lines in a doc comment into a single
\n. When we then try to treat that text as markdown (e.g., on the docs site), markdown ignores single blank lines. This is the difference between thisand this
So here we keep those blank lines as a double
\n\n.