Skip to content

Doc EN : Add ` on code part to consistency and comprehension #1405

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

Merged
merged 3 commits into from
May 29, 2017

Conversation

MachinisteWeb
Copy link
Contributor

All is in title ;) It's all we have see/change for getting-started.md while our translation process.

@posva
Copy link
Member

posva commented May 10, 2017

Thanks for the contribution. Since the text won't change because it's inside of a code block, I really think it's better to have them without the backticks as it makes it easier to read
WDYT @fnlctrl ?

@MachinisteWeb
Copy link
Contributor Author

MachinisteWeb commented May 10, 2017

Ok but in this case that means which things like <a> or to which will be originally between « tick » which must be « without tick »because, for example, in this sentence:

<!-- <router-link> will be rendered as an `<a>` tag by default -->

there is a lack of consitency between « <router-link> » and « <a> »


Our advice is this:

// short for `routes: routes`

is more readable than this

// short for routes: routes

« : is a part of a phrase ponctuation? »

@posva
Copy link
Member

posva commented May 10, 2017 via email

@MachinisteWeb
Copy link
Contributor Author

MachinisteWeb commented May 27, 2017

Some others cases in all documentation and others PR (like following) tend to thinking Evan choice to also tick:

so let him save some time @posva ;)

@posva
Copy link
Member

posva commented May 29, 2017

yeah, I've been merging them for some time now. Feel free to add that to other PRs as well

@posva posva merged commit c1e89e1 into vuejs:dev May 29, 2017
@MachinisteWeb MachinisteWeb deleted the getting-started branch June 5, 2017 08:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants