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

Remove mid-paragraph line breaks from 2-building-a-list-of-pages.md markdown #41025

Merged
merged 1 commit into from
May 16, 2022

Conversation

adamziel
Copy link
Contributor

@adamziel adamziel commented May 12, 2022

What?

Removes the line breaks from the markdown tutorial. They don't look good when rendered to HTML in the handbook:

CleanShot 2022-05-12 at 14 25 25

Testing Instructions

I don't think there's a way to test this. Just eyeball this PR and confirm it makes sense.

cc @atachibana @scruffian @getdave @dmsnell

@adamziel adamziel self-assigned this May 12, 2022
@adamziel adamziel added [Type] Developer Documentation Documentation for developers [Package] Core data /packages/core-data labels May 12, 2022
@dmsnell
Copy link
Member

dmsnell commented May 12, 2022

Looks like something is wrong with our Markdown renderer else it's adopted non-standard behavior, as manual single line breaks (to my knowledge) should not introduce breaks in the output. The result should be identical before and after this change.

It appears like GitHub does this as well, which might have influenced other renderers to adopt it. New lines should be indicated by ending a line with a couple of space characters and then a newline. This is/was (I think) to keep it reasonable to edit Markdown documents in editors without soft-wrapping.

I guess it's fine to address this by removing the newlines, but that also seems like it is changing code to workaround a bug. I'm curious how prevalent this situation is in the docs.

@adamziel adamziel merged commit e120d07 into trunk May 16, 2022
@adamziel adamziel deleted the fix/handbook-formatting-in-create-data-app branch May 16, 2022 12:21
@github-actions github-actions bot added this to the Gutenberg 13.3 milestone May 16, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Package] Core data /packages/core-data [Type] Developer Documentation Documentation for developers
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants