Skip to content

Commit 393c5e1

Browse files
committed
update docstrings (again)
1 parent 124281b commit 393c5e1

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

src/v2/providers/firestore.ts

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -179,7 +179,7 @@ export function onDocumentWritten<Document extends string>(
179179

180180
/**
181181
* Event handler that triggers when a document is created, updated, or deleted in Firestore.
182-
* This trigger will also provide the authentication context of the principal who triggered the event.
182+
* This trigger also provides the authentication context of the principal who triggered the event.
183183
*
184184
* @param document - The Firestore document path to trigger on.
185185
* @param handler - Event handler which is run every time a Firestore create, update, or delete occurs.
@@ -193,7 +193,7 @@ export function onDocumentWrittenWithAuthContext<Document extends string>(
193193

194194
/**
195195
* Event handler that triggers when a document is created, updated, or deleted in Firestore.
196-
* This trigger will also provide the authentication context of the principal who triggered the event.
196+
* This trigger also provides the authentication context of the principal who triggered the event.
197197
*
198198
* @param opts - Options that can be set on an individual event-handling function.
199199
* @param handler - Event handler which is run every time a Firestore create, update, or delete occurs.
@@ -207,7 +207,7 @@ export function onDocumentWrittenWithAuthContext<Document extends string>(
207207

208208
/**
209209
* Event handler that triggers when a document is created, updated, or deleted in Firestore.
210-
* This trigger will also provide the authentication context of the principal who triggered the event.
210+
* This trigger also provides the authentication context of the principal who triggered the event.
211211
*
212212
* @param opts - Options or a string document path.
213213
* @param handler - Event handler which is run every time a Firestore create, update, or delete occurs.
@@ -264,7 +264,7 @@ export function onDocumentCreated<Document extends string>(
264264

265265
/**
266266
* Event handler that triggers when a document is created in Firestore.
267-
* This trigger will also provide the authentication context of the principal who triggered the event.
267+
* This trigger also provides the authentication context of the principal who triggered the event.
268268
*
269269
* @param document - The Firestore document path to trigger on.
270270
* @param handler - Event handler which is run every time a Firestore create occurs.
@@ -278,7 +278,7 @@ export function onDocumentCreatedWithAuthContext<Document extends string>(
278278

279279
/**
280280
* Event handler that triggers when a document is created in Firestore.
281-
* This trigger will also provide the authentication context of the principal who triggered the event.
281+
* This trigger also provides the authentication context of the principal who triggered the event.
282282
*
283283
* @param opts - Options that can be set on an individual event-handling function.
284284
* @param handler - Event handler which is run every time a Firestore create occurs.
@@ -347,7 +347,7 @@ export function onDocumentUpdated<Document extends string>(
347347

348348
/**
349349
* Event handler that triggers when a document is updated in Firestore.
350-
* This trigger will also provide the authentication context of the principal who triggered the event.
350+
* This trigger also provides the authentication context of the principal who triggered the event.
351351
*
352352
* @param document - The Firestore document path to trigger on.
353353
* @param handler - Event handler which is run every time a Firestore update occurs.
@@ -360,7 +360,7 @@ export function onDocumentUpdatedWithAuthContext<Document extends string>(
360360
): CloudFunction<FirestoreEvent<Change<QueryDocumentSnapshot> | undefined, ParamsOf<Document>>>;
361361
/**
362362
* Event handler that triggers when a document is updated in Firestore.
363-
* This trigger will also provide the authentication context of the principal who triggered the event.
363+
* This trigger also provides the authentication context of the principal who triggered the event.
364364
*
365365
* @param opts - Options that can be set on an individual event-handling function.
366366
* @param handler - Event handler which is run every time a Firestore update occurs.
@@ -430,7 +430,7 @@ export function onDocumentDeleted<Document extends string>(
430430

431431
/**
432432
* Event handler that triggers when a document is deleted in Firestore.
433-
* This trigger will also provide the authentication context of the principal who triggered the event.
433+
* This trigger also provides the authentication context of the principal who triggered the event.
434434
*
435435
* @param document - The Firestore document path to trigger on.
436436
* @param handler - Event handler which is run every time a Firestore delete occurs.
@@ -444,7 +444,7 @@ export function onDocumentDeletedWithAuthContext<Document extends string>(
444444

445445
/**
446446
* Event handler that triggers when a document is deleted in Firestore.
447-
* This trigger will also provide the authentication context of the principal who triggered the event.
447+
* This trigger also provides the authentication context of the principal who triggered the event.
448448
*
449449
* @param opts - Options that can be set on an individual event-handling function.
450450
* @param handler - Event handler which is run every time a Firestore delete occurs.

0 commit comments

Comments
 (0)