[api-documenter] Fix return block rendering for page markdown #4638
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.
Summary
Fixes rendering of the "**Returns:**" markdown in generated page documentation for a function.
Details
Noticed that a missing line break was causing the
Returns:
section on the markdown output for a function to be rendered incorrectly. You can see an example of this here.The markdown is correct (
**Returns:**
) but because there is no line break between the end of the parameter table and the aforementioned markdown content, it is not treated as a new paragraph and is instead rendered as "**Returns:**" instead of "Returns:".This is fixed by adding the required line break to the generated markdown content.
How it was tested
I rebuild the
api-documenter
with the included code change and regenerated the markdown pages for my project and visually compared them.I also updated the just snapshot used for the markdown test.
Impacted documentation
Not applicable.