Skip to content
This repository has been archived by the owner on Feb 22, 2023. It is now read-only.

Breaking changes to signature of snapshots and setData in cloud_firestore #536

Merged
merged 5 commits into from
May 7, 2018

Conversation

collinjackson
Copy link
Contributor

No description provided.

Copy link
Contributor

@mravn-google mravn-google left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

## 0.7.0

* **Breaking change**. snapshots is now a method instead of a getter.
* **Breaking change**. setData uses optional arguments instead of SetOptions.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe use code font on snapshots, setData, and SetOptions to avoid having the entry look like a spelling error with lowercase word following the full stop.

[nit] optional arguments => named argument?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done

/// document does not yet exist, it will be created.
///
/// If [merge] is true, the provided data will be merged into an
/// existing document.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please document the default semantics: overwrite?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done

@@ -61,10 +61,10 @@ class WriteBatch {
///
/// If the document does not yet exist, it will be created.
///
/// If you pass [SetOptions], the provided data will be merged into an
/// If [merge] is true, the provided data will be merged into an
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same here.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done

@collinjackson collinjackson merged commit 4acdcc1 into flutter:master May 7, 2018
slightfoot pushed a commit to slightfoot/plugins that referenced this pull request Jun 5, 2018
…tore (flutter#536)

These changes are required to support the metadata argument to snapshots and other future API changes.
julianscheel pushed a commit to jusst-engineering/plugins that referenced this pull request Mar 11, 2020
…tore (flutter#536)

These changes are required to support the metadata argument to snapshots and other future API changes.
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
3 participants