Skip to content

Fix documentation for getDocsFromCache. #6879

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

Merged
merged 2 commits into from
Dec 12, 2022

Conversation

MarkDuckworth
Copy link
Contributor

@MarkDuckworth MarkDuckworth commented Dec 12, 2022

Fix documentation for getDocsFromCache. Specifically this updates the line stating that the function will throw if documents are not cached, and instead states that the function will return an empty result set if documents are not cached. Fixes #6851

@changeset-bot
Copy link

changeset-bot bot commented Dec 12, 2022

🦋 Changeset detected

Latest commit: 9b158cd

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 3 packages
Name Type
@firebase/firestore Patch
firebase Patch
@firebase/firestore-compat Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@github-actions
Copy link
Contributor

github-actions bot commented Dec 12, 2022

Changeset File Check ✅

  • No modified packages are missing from the changeset file.
  • No changeset formatting errors detected.

@google-oss-bot
Copy link
Contributor

google-oss-bot commented Dec 12, 2022

@google-oss-bot
Copy link
Contributor

google-oss-bot commented Dec 12, 2022

@MarkDuckworth MarkDuckworth merged commit 37f31c5 into master Dec 12, 2022
@MarkDuckworth MarkDuckworth deleted the markduckworth/fix-docs-getDocsFromCache branch December 12, 2022 22:48
@firebase firebase locked and limited conversation to collaborators Jan 12, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

getDocsFromCache - Possible inconsistency between API reference and source code
3 participants