Skip to content

Commit f042932

Browse files
committed
Rename sample stage parameter to "count"
1 parent d831d75 commit f042932

File tree

1 file changed

+3
-3
lines changed
  • firebase-firestore/src/main/java/com/google/firebase/firestore

1 file changed

+3
-3
lines changed

firebase-firestore/src/main/java/com/google/firebase/firestore/Pipeline.kt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -504,15 +504,15 @@ private constructor(
504504
/**
505505
* Performs a pseudo-random sampling of the input documents.
506506
*
507-
* The [documents] parameter represents the target number of documents to produce and must be a
507+
* The [count] parameter represents the target number of documents to produce and must be a
508508
* non-negative integer value. If the previous stage produces less than size documents, the entire
509509
* previous results are returned. If the previous stage produces more than size, this outputs a
510510
* sample of exactly size entries where any sample is equally likely.
511511
*
512-
* @param documents The number of documents to emit.
512+
* @param count The number of documents to emit.
513513
* @return A new [Pipeline] object with this stage appended to the stage list.
514514
*/
515-
fun sample(documents: Int): Pipeline = append(SampleStage.withCount(documents))
515+
fun sample(count: Int): Pipeline = append(SampleStage.withCount(count))
516516

517517
/**
518518
* Performs a pseudo-random sampling of the input documents.

0 commit comments

Comments
 (0)