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

Correct markdown to avoid comment #6009

Merged
merged 1 commit into from
Dec 11, 2018
Merged

Conversation

souzasmatheus
Copy link
Contributor

No description provided.

@mrmckeb
Copy link
Contributor

mrmckeb commented Dec 11, 2018

Hi @souzasmatheus, thanks for the PR. Can you add a little information about this? For example, why do you feel this change is important?

I think the markdown is there because a) these are routes, and all routes in this file are commented, and b) because it creates a nice alignment of the comments.

An alternative might be a table... but that doesn't feel necessary here.

@souzasmatheus
Copy link
Contributor Author

souzasmatheus commented Dec 11, 2018

Hi, @mrmckeb. How are you?

While reading create-react-app's documentation, I realized * was used to refer to all files and directories inside the /api/ directory. However, since it was written inside a markdown code block, turns out everything after /api/* was interpreted as a comment, whereas it should not have been that way.

I propose that, instead of using markdown's ``` notation, we use tab or four spaces. It will preserve the code block but will not create an unnecessary comment.

@iansu
Copy link
Contributor

iansu commented Dec 11, 2018

This does seem to solve the problem if you look at the preview: https://deploy-preview-6009--create-react-app.netlify.com/create-react-app/docs/proxying-api-requests-in-development

Thanks!

@iansu iansu added this to the 2.1.2 milestone Dec 11, 2018
@iansu iansu merged commit 45bc628 into facebook:master Dec 11, 2018
@souzasmatheus
Copy link
Contributor Author

My pleasure!

hisapy pushed a commit to iporaitech/create-react-app that referenced this pull request Dec 14, 2018
@lock lock bot locked and limited conversation to collaborators Jan 8, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants