docs: improve API reference of watch and subscribe #1195
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
docs/en/api.md
Outdated
| Reactively watch `fn`'s return value, and call the callback when the value changes. `fn` receives the store's state as the first argument, and getters as the second argument. Accepts an optional options object that takes the same options as Vue's `vm.$watch` method. | ||
| To stop watching, call the returned handle function. | ||
| To stop watching, call the returned handler function. |
Member
There was a problem hiding this comment.
I believe handle is the correct word here which means a reference to stop watch. https://en.wikipedia.org/wiki/Handle_(computing)
On the other hand, handler in computer science usually means a event listener that handles event. https://en.wikipedia.org/wiki/Handler
Indeed handle is quite hard to grasp here, maybe we can say the returned unwatch function ?
Member
Author
There was a problem hiding this comment.
Oh, I didn't know about the meaning of handle!
I guess the returned unwatch (unsubscribe) function would be clearer 🙂
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
store#watch's 1st argument. It was actually a getter function until v1.x but the current getter is not a simple function. (fix The wording of Store.watch in API reference is confusable #1141)subscribe/subscribeAction. (fix The Vuex documentation does not document how to unsubscribe from subscribe and subscribeAction #1194)