Skip to content

Commit a7a35f0

Browse files
Update wording for merge message (#9131)
1 parent 00625a6 commit a7a35f0

File tree

3 files changed

+10
-11
lines changed

3 files changed

+10
-11
lines changed

Firestore/Source/Public/FirebaseFirestore/FIRDocumentReference.h

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ NS_SWIFT_NAME(DocumentReference)
9292
* document.
9393
* @param merge Whether to merge the provided data into any existing document. If enabled,
9494
* all omitted fields remain untouched. If your input sets any field to an empty dictionary, any
95-
* nested field at this location is overwritten.
95+
* nested field is overwritten.
9696
*/
9797
- (void)setData:(NSDictionary<NSString *, id> *)documentData merge:(BOOL)merge;
9898

@@ -109,8 +109,7 @@ NS_SWIFT_NAME(DocumentReference)
109109
* to be written.
110110
* @param mergeFields An `NSArray` that contains a list of `NSString` or `FIRFieldPath` elements
111111
* specifying which fields to merge. Fields can contain dots to reference nested fields within
112-
* the document. If your input sets any field to an empty dictionary, any nested field at this
113-
* location is overwritten.
112+
* the document. If your input sets any field to an empty dictionary, any nested field is overwritten.
114113
*/
115114
- (void)setData:(NSDictionary<NSString *, id> *)documentData mergeFields:(NSArray<id> *)mergeFields;
116115

@@ -134,7 +133,8 @@ NS_SWIFT_NAME(DocumentReference)
134133
*
135134
* @param documentData An `NSDictionary` containing the fields that make up the document
136135
* to be written.
137-
* @param merge Whether to merge the provided data into any existing document.
136+
* @param merge Whether to merge the provided data into any existing document. If your input sets
137+
* any field to an empty dictionary, any nested field is overwritten.
138138
* @param completion A block to execute once the document has been successfully written to the
139139
* server. This block will not be called while the client is offline, though local
140140
* changes will be visible immediately.
@@ -156,7 +156,8 @@ NS_SWIFT_NAME(DocumentReference)
156156
* to be written.
157157
* @param mergeFields An `NSArray` that contains a list of `NSString` or `FIRFieldPath` elements
158158
* specifying which fields to merge. Fields can contain dots to reference nested fields within
159-
* the document.
159+
* the document. If your input sets any field to an empty dictionary, any nested field is
160+
* overwritten.
160161
* @param completion A block to execute once the document has been successfully written to the
161162
* server. This block will not be called while the client is offline, though local
162163
* changes will be visible immediately.

Firestore/Source/Public/FirebaseFirestore/FIRTransaction.h

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ NS_SWIFT_NAME(Transaction)
5656
* @param document A reference to the document whose data should be overwritten.
5757
* @param merge Whether to merge the provided data into any existing document. If enabled,
5858
* all omitted fields remain untouched. If your input sets any field to an empty dictionary, any
59-
* nested field at this location is overwritten.
59+
* nested field is overwritten.
6060
* @return This `FIRTransaction` instance. Used for chaining method calls.
6161
*/
6262
// clang-format off
@@ -80,8 +80,7 @@ NS_SWIFT_NAME(Transaction)
8080
* @param document A reference to the document whose data should be overwritten.
8181
* @param mergeFields An `NSArray` that contains a list of `NSString` or `FIRFieldPath` elements
8282
* specifying which fields to merge. Fields can contain dots to reference nested fields within
83-
* the document. If your input sets any field to an empty dictionary, any nested field at this
84-
* llocation is overwritten.
83+
* the document. If your input sets any field to an empty dictionary, any nested field is overwritten.
8584
* @return This `FIRTransaction` instance. Used for chaining method calls.
8685
*/
8786
// clang-format off

Firestore/Source/Public/FirebaseFirestore/FIRWriteBatch.h

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ NS_SWIFT_NAME(WriteBatch)
5959
* @param document A reference to the document whose data should be overwritten.
6060
* @param merge Whether to merge the provided data into any existing document. If enabled,
6161
* all omitted fields remain untouched. If your input sets any field to an empty dictionary, any
62-
* nested field at this location is overwritten.
62+
* nested field is overwritten.
6363
* @return This `FIRWriteBatch` instance. Used for chaining method calls.
6464
*/
6565
// clang-format off
@@ -82,8 +82,7 @@ NS_SWIFT_NAME(WriteBatch)
8282
* @param document A reference to the document whose data should be overwritten.
8383
* @param mergeFields An `NSArray` that contains a list of `NSString` or `FIRFieldPath` elements
8484
* specifying which fields to merge. Fields can contain dots to reference nested fields within
85-
* the document. If your input sets any field to an empty dictionary, any nested field at this
86-
* location is overwritten.
85+
* the document. If your input sets any field to an empty dictionary, any nested field is overwritten.
8786
* @return This `FIRWriteBatch` instance. Used for chaining method calls.
8887
*/
8988
// clang-format off

0 commit comments

Comments
 (0)