Update CHANGELOG.md to mention limbo resolution throttling #2864
Conversation
This file contains 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
This change to the change log was forgotten in the PR that added throttling: #2790
|
/retest |
wilhuff
reviewed
Apr 3, 2020
packages/firestore/CHANGELOG.md
Outdated
| @@ -1,4 +1,9 @@ | |||
| # Unreleased | |||
| - [changed] Limbo resolution now attempts to resolve a maximum of 100 documents | |||
There was a problem hiding this comment.
Changelogs are hard. They end up in our release notes: https://firebase.google.com/support/release-notes/js so they should be comprehensible by our end users.
This note has some problems:
- "Limbo resolution" is not an end-user concept we've documented.
- There's too much detail ("resource exhausted", 15,000)
- It links to the PR and the issue we're fixing, when one is sufficient
So the way to write this is to think about what we're doing on users' behalf when performing limbo resolution. At a high level we're "resolving cache inconsistencies" or "resolving inconsistencies in the local cache".
How about:
Firestore now limits the number of concurrent document lookups it will perform when resolving inconsistencies in the local cache (#2683).
There was a problem hiding this comment.
Done. I like how you said the same thing with 50% fewer words :)
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
This change to the change log was forgotten in the PR that added throttling: #2790