-
Notifications
You must be signed in to change notification settings - Fork 4.7k
fix: typos inside of public markdown docs #1500
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
Conversation
✔️ Deploy Preview for vuejs ready! 🔨 Explore the source changes: ffbd03f 🔍 Inspect the deploy log: https://app.netlify.com/sites/vuejs/deploys/6201db449a8cb300073cbf52 😎 Browse the preview: https://deploy-preview-1500--vuejs.netlify.app |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@JessicaSachs thank you for catching so many typos! I've left comments on the cases I disagree with, rest of the fixes look great to me 👍🏻
src/api/component-instance.md
Outdated
@@ -251,10 +251,10 @@ Imperative API for creating watchers. | |||
Stopping the watcher: | |||
|
|||
```js | |||
const unwatch = this.$watch('a', cb) | |||
const stopWatching = this.$watch('a', cb) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
question: Could you please provide more context on why this change is necessary?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Unwatch didn't pass spellcheck. I didn't realize it was even a word. https://en.m.wiktionary.org/wiki/unwatch it's marked as rare because it isn't used often.
stopWatching
is much clearer and passes spellcheck.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't feel strongly about it.
I didn't realize we'd get so many typo PRs after launching the website 😅. I don't think any of these are duplicates.
The changes are scoped to the public markdown documents, not code, so there shouldn't be much risk.