Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[api-documenter] Fix return block rendering for page markdown #4638

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

colincasey
Copy link

@colincasey colincasey commented Apr 13, 2024

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.

@colincasey
Copy link
Author

@microsoft-github-policy-service agree

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: AE/AD
Development

Successfully merging this pull request may close these issues.

1 participant