Update CHANGELOG.md #1198
Merged
Update CHANGELOG.md #1198
Conversation
This file contains hidden or 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
schmidt-sebastian
requested review from
gsoltis,
mikelehen,
rsgowman,
var-const,
wilhuff and
zxu123
as code owners
wilhuff
reviewed
Sep 5, 2018
packages/firestore/CHANGELOG.md
Outdated
| @@ -1,4 +1,9 @@ | |||
| # Unreleased | |||
| # Unreleased (0.8.1) | |||
| - [changed] The internal handling for locally updated documents that haven't yet | |||
There was a problem hiding this comment.
Most of these notes start with the verb (i.e. "Changed" in this case).
If possible it would be worthwhile to vaguely describe what the differences might be. Something like: SnapshotMetadata.hasPendingWrites may now be cleared earlier than it used to (or whatever the actual change is).
One key difference here is that after restart an acknowledged but unobserved document will have hasPendingWrites: false but fromCache: true. Should we make note that users wanting to make sure documents are non-dirty should check for either condition?
There was a problem hiding this comment.
Updated Changelog per our discussion:
- Changed the wording slightly to start with "Changed", but didn't mention the restart case since that hasn't actually changed in behavior. I also shied away from adding more detail since it is really hard to describe to external users.
- Added a section on how we no longer rebase mutations as we get outdated document updates.
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.
Firestore change log for held write acks change.