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

[docs] Update comment about GitHub breaks #1620

Merged
merged 3 commits into from
Mar 19, 2020
Merged

Conversation

julien-c
Copy link
Contributor

GitHub does not, in fact, appear to break on a single line.

GitHub does not, in fact, appear to break on a single line.
@vercel
Copy link

vercel bot commented Mar 17, 2020

This pull request is being automatically deployed with ZEIT Now (learn more).
To see the status of your deployment, click below or on the icon next to each commit.

🔍 Inspect: https://zeit.co/markedjs/markedjs/5z6k4mrtb
✅ Preview: https://markedjs-git-fork-julien-c-patch-1.markedjs.now.sh

@UziTech
Copy link
Member

UziTech commented Mar 17, 2020

these lines are separated
by a single new line (\n)

GitHub does break on a single new line.

If you view the source for the two lines above you will see a <br> between them instead of being two paragraphs.

image

@UziTech
Copy link
Member

UziTech commented Mar 17, 2020

Can you provide an example of when GitHub does not break on a single new line character?

@julien-c
Copy link
Contributor Author

Ah, interesting, this seems to be specific to comments. GitHub does not break on a single \n in (at least):

docs/USING_ADVANCED.md Outdated Show resolved Hide resolved
Co-Authored-By: Steven <steven@ceriously.com>
docs/USING_ADVANCED.md Outdated Show resolved Hide resolved
@julien-c
Copy link
Contributor Author

Thanks for the suggestion @UziTech @styfle, I reworded the description. What do you think?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
category: docs Documentation changes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants