doc: spelling and formatting #6681
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
posva
reviewed
Sep 25, 2017
| @@ -2,9 +2,9 @@ | |||
|
|
|||
| This benchmark renders a table of 1000 rows with 10 columns (10k components), with around 30k normal elements on the page. Note this is not something likely to be seen in a typical app. This benchmark is mostly for stress/regression testing and comparing between `renderToString` and `renderToStream`. | |||
|
|
|||
| To view the results follow the run section. Note that the overall completion time for the results are variable, this is due to other system related variants at run time (available memory, processing ect). In ideal circumstances both should finish within similar results. | |||
posva
reviewed
Sep 25, 2017
| @@ -2,7 +2,7 @@ | |||
|
|
|||
| > This package is auto-generated. For pull requests please see [src/platforms/web/entry-compiler.js](https://github.com/vuejs/vue/tree/dev/src/platforms/web/entry-compiler.js). | |||
|
|
|||
| This package can be used to pre-compile Vue 2.0 templates into render functions to avoid runtime-compilation overhead and CSP restrictions. You will only need it if you are writing build tools with very specific needs. In most cases you should be using [vue-loader](https://github.com/vuejs/vue-loader) or [vueify](https://github.com/vuejs/vueify) instead, both of which use this package internally. | |||
| This package can be used to pre-compile Vue 2.0 templates into render functions to avoid runtime-compilation overhead and CSP restrictions. You will only need it if you are writing build tools with very specific needs. In most cases you should be using [`vue-loader`](https://github.com/vuejs/vue-loader) or [`vueify`](https://github.com/vuejs/vueify) instead, both of which use this package internally. | |||
There was a problem hiding this comment.
I don't think those should be wrapped with backticks, they're just package names after all
There was a problem hiding this comment.
To reference the current HEAD version https://raw.githubusercontent.com/vuejs/vue/master/packages/vue-template-compiler/README.md the string vue-loader shows up 4 times. In 3 of those cases the name is wrapped in backticks:
In most cases you should be using [vue-loader](https://github.com/vuejs/vue-loader) ...
... e.g `vue-loader` and `vueify`.**
This is used by default in `vue-loader@>=12` ...
This is used in SFC build tools like `vue-loader` and `vueify`.
ztlevi
pushed a commit
to ztlevi/vue
that referenced
this pull request
Feb 14, 2018
f2009
pushed a commit
to f2009/vue
that referenced
this pull request
Jan 25, 2019
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What kind of change does this PR introduce? (check at least one)
Does this PR introduce a breaking change? (check one)
The PR fulfills these requirements:
devbranch for v2.x (or to a previous version branch), not themasterbranchOther information:
When mentioning certain library names like
vueifyandvue-loader, the documentation uses backticks in some places but not in others. Of the cases I noticed, most were in links. GitHub permits backticks within links and they are rendered with the fixed-width fontQThe main README.md omits them for vue-loader. To show the difference, I took the specific line from the table and included both forms:
*.vuefile) loader for webpackvue-loader*.vuefile) loader for webpackThis PR does not include the aforementioned change, but if that is desirable I can add it in.