Skip to content

An example output in API Docs seems misleading #1137

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

Closed
1 of 5 tasks
mighty-odewumi opened this issue Aug 1, 2024 · 0 comments · Fixed by #1139
Closed
1 of 5 tasks

An example output in API Docs seems misleading #1137

mighty-odewumi opened this issue Aug 1, 2024 · 0 comments · Fixed by #1139
Labels
bug Something isn't working

Comments

@mighty-odewumi
Copy link

What happened?

An example under the https://react-native-async-storage.github.io/async-storage/docs/api#multimerge site does not correctly show the use-case of the multiGet API used in the example.

This could probably deter someone who's going through the docs and trying to whip up some solutions. They could worry about why they're getting a different output from what the example code gave and expend some precious time.

Version

1.21.0

What platforms are you seeing this issue on?

  • Android
  • iOS
  • macOS
  • Windows
  • web

System Information

react-native: 0.73.6
react: 18.2.0

Steps to Reproduce

@mighty-odewumi mighty-odewumi added the bug Something isn't working label Aug 1, 2024
mensonones added a commit to mensonones/async-storage that referenced this issue Aug 21, 2024
Fixes the output example code in the multiMerge API documentation. react-native-async-storage#1137
@tido64 tido64 linked a pull request Aug 21, 2024 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant