Skip to content

Commit 884b101

Browse files
committed
[Docs] Add comments above isFieldDuplicated func
1 parent 427b089 commit 884b101

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

Sources/SHFirestoreService/FirestoreQueryable.swift

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,8 +35,11 @@ public protocol FirestoreQueryable {
3535

3636
/// Checks if a document is duplicated or not from the endpoint requestType is a collectionRef using firestore's query.
3737
///
38-
/// This method executes a Firestore query to check if the specified field in the document is duplicated from a collection reference.
39-
/// The query is executed using the provided endpoint and query handler.
38+
/// Notes:
39+
/// 1. This method executes a Firestore query to check if the specified field in the document is duplicated from a collection reference.
40+
/// 2. endpoint's a documentRef computed property of requestType property should return nil.
41+
/// 3. The query is executed using the provided endpoint and query handler.
42+
/// 4. The requestType of endpoint is not used.
4043
///
4144
/// - Parameters:
4245
/// - endpoint: The Firestore endpoint to query, which must conform to `FirestoreEndopintable`.

0 commit comments

Comments
 (0)