vuejs / vuejs/docs

Composables async-state-example code block does not match playground's code

Open
#2,529 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Vue
Stars
3.2k
Forks
5k
Avg merge
14d 17h
Merged PRs (30d)
1

Description

https://vuejs.org/guide/reusability/composables.html#async-state-example

near the bottom of this section, when discussing the watchEffect() / toValue() refactor, the copy reads:

Notice that toValue(url) is called inside the watchEffect callback. This ensures that any reactive dependencies accessed during the toValue() normalization are tracked by the watcher.

the code block above on this docs page does not match this. it appears to be referencing code that can be seen behind the updated version of useFetch() code link

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Open the composables documentation at the async-state-example section and compare its code block with the updated useFetch() version in the linked Vue playground. Align the displayed example with the explanation about watchEffect() and toValue(), then verify that the rendered documentation and code match.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.