Skip to content
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

Update documentation for the Bound Mutate example #477

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

hytea
Copy link

@hytea hytea commented Mar 31, 2023

This is a link to the documentation that I found incorrect: https://swr.vercel.app/docs/mutation#bound-mutate

A bound mutate method requires a KeyedMutator which is either Data or a Promise to return Data.

This issue actually gives a good example of the todos. You may prefer to update this whole page to use the todo example.

Description

I was trying to follow the example in the Bound mutator section of the documentation and came across this example which is wrong. A bound mutator requires a KeyedMutator which requires Data or a Promise to return Data.

image

  • Adding new page
  • Updating existing documentation
  • Other updates

A bound mutate method requires a KeyedMutator which is either Data or a Promise to return Data.
@hytea hytea requested review from shuding and huozhi as code owners March 31, 2023 22:40
@vercel
Copy link

vercel bot commented Mar 31, 2023

@hytea is attempting to deploy a commit to the Vercel Team on Vercel.

A member of the Team first needs to authorize it.

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.

1 participant