add at least one restriction in the documentation

Author: cherylEnkidu

Firestore/Swift/Source/SwiftAPI/Pipeline/Expression.swift

@@ -185,8 +185,7 @@ public protocol Expression: Sendable {
   /// // Combine the "items" array with "otherItems" and "archiveItems" array fields.
   /// Field("items").arrayConcat(Field("otherItems"), Field("archiveItems"))
   /// ```
-  /// - Parameter secondArray: An `Expression` (evaluating to an array) to concatenate.
-  /// - Parameter otherArrays: Optional additional `Expression` values (evaluating to arrays) to
+  /// - Parameter arrays: An array of at least one `Expression` (evaluating to an array) to
   /// concatenate.
   /// - Returns: A new `FunctionExpression` representing the concatenated array.
   func arrayConcat(_ arrays: [Expression]) -> FunctionExpression
@@ -199,9 +198,7 @@ public protocol Expression: Sendable {
   /// // Combine "tags" (an array field) with ["new", "featured"] and ["urgent"]
   /// Field("tags").arrayConcat(["new", "featured"], ["urgent"])
   /// ```
-  /// - Parameter secondArray: An array literal of `Sendable` values to concatenate.
-  /// - Parameter otherArrays: Optional additional array literals of `Sendable` values to
-  /// concatenate.
+  /// - Parameter arrays: An array of at least one `Sendable` values to concatenate.
   /// - Returns: A new `FunctionExpression` representing the concatenated array.
   func arrayConcat(_ arrays: [[Sendable]]) -> FunctionExpression
 
@@ -255,8 +252,7 @@ public protocol Expression: Sendable {
   /// Field("tags").arrayContainsAll(["urgent", "review"])
   /// ```
   ///
-  /// - Parameter values: A list of `Sendable` literal elements to check for in the array
-  /// represented by `self`.
+  /// - Parameter values: An array of at least one `Sendable` element to check for in the array.
   /// - Returns: A new `BooleanExpr` representing the "array_contains_all" comparison.
   func arrayContainsAll(_ values: [Sendable]) -> BooleanExpression
 
@@ -269,8 +265,7 @@ public protocol Expression: Sendable {
   /// Field("userGroups").arrayContainsAny([Field("allowedGroup1"), Field("allowedGroup2")])
   /// ```
   ///
-  /// - Parameter values: A list of `Expression` elements to check for in the array represented
-  /// by `self`.
+  /// - Parameter values: A list of `Expression` elements to check for in the array.
   /// - Returns: A new `BooleanExpr` representing the "array_contains_any" comparison.
   func arrayContainsAny(_ values: [Expression]) -> BooleanExpression
 
@@ -283,8 +278,7 @@ public protocol Expression: Sendable {
   /// Field("categories").arrayContainsAny(["electronics", "books"])
   /// ```
   ///
-  /// - Parameter values: A list of `Sendable` literal elements to check for in the array
-  /// represented by `self`.
+  /// - Parameter values: An array of at least one `Sendable` element to check for in the array.
   /// - Returns: A new `BooleanExpr` representing the "array_contains_any" comparison.
   func arrayContainsAny(_ values: [Sendable]) -> BooleanExpression
 
@@ -425,7 +419,7 @@ public protocol Expression: Sendable {
   /// Field("categoryID").eqAny([Field("featuredCategory"), Field("popularCategory")])
   /// ```
   ///
-  /// - Parameter others: A list of `Expression` values to check against.
+  /// - Parameter others: An array of at least one `Expression` value to check against.
   /// - Returns: A new `BooleanExpr` representing the "IN" comparison (eq_any).
   func eqAny(_ others: [Expression]) -> BooleanExpression
 
@@ -438,7 +432,7 @@ public protocol Expression: Sendable {
   /// Field("category").eqAny(["Electronics", "Books", "Home Goods"])
   /// ```
   ///
-  /// - Parameter others: A list of `Sendable` literal values to check against.
+  /// - Parameter others: An array of at least one `Sendable` literal value to check against.
   /// - Returns: A new `BooleanExpr` representing the "IN" comparison (eq_any).
   func eqAny(_ others: [Sendable]) -> BooleanExpression
 
@@ -451,7 +445,7 @@ public protocol Expression: Sendable {
   /// Field("statusValue").notEqAny([Field("archivedStatus"), Field("deletedStatus")])
   /// ```
   ///
-  /// - Parameter others: A list of `Expression` values to check against.
+  /// - Parameter others: An array of at least one `Expression` value to check against.
   /// - Returns: A new `BooleanExpr` representing the "NOT IN" comparison (not_eq_any).
   func notEqAny(_ others: [Expression]) -> BooleanExpression
 
@@ -464,7 +458,7 @@ public protocol Expression: Sendable {
   /// Field("status").notEqAny(["pending", "archived"])
   /// ```
   ///
-  /// - Parameter others: A list of `Sendable` literal values to check against.
+  /// - Parameter others: An array of at least one `Sendable` literal value to check against.
   /// - Returns: A new `BooleanExpr` representing the "NOT IN" comparison (not_eq_any).
   func notEqAny(_ others: [Sendable]) -> BooleanExpression
 
@@ -1060,8 +1054,7 @@ public protocol Expression: Sendable {
   /// Field("val1").logicalMaximum(Field("val2"), Field("val3"))
   /// ```
   ///
-  /// - Parameter second: The second `Expr` to compare with.
-  /// - Parameter others: Optional additional `Expr` values to compare with.
+  /// - Parameter expressions: An array of at least one `Expression` to compare with.
   /// - Returns: A new `FunctionExpression` representing the logical max operation.
   func logicalMaximum(_ expressions: [Expression]) -> FunctionExpression
 
@@ -1073,8 +1066,7 @@ public protocol Expression: Sendable {
   /// Field("val1").logicalMaximum(100, 200.0)
   /// ```
   ///
-  /// - Parameter second: The second literal `Sendable` value to compare with.
-  /// - Parameter others: Optional additional literal `Sendable` values to compare with.
+  /// - Parameter values: An array of at least one `Sendable` value to compare with.
   /// - Returns: A new `FunctionExpression` representing the logical max operation.
   func logicalMaximum(_ values: [Sendable]) -> FunctionExpression
 
@@ -1086,8 +1078,7 @@ public protocol Expression: Sendable {
   /// Field("val1").logicalMinimum(Field("val2"), Field("val3"))
   /// ```
   ///
-  /// - Parameter second: The second `Expr` to compare with.
-  /// - Parameter others: Optional additional `Expr` values to compare with.
+  /// - Parameter expressions: An array of at least one `Expression` to compare with.
   /// - Returns: A new `FunctionExpression` representing the logical min operation.
   func logicalMinimum(_ expressions: [Expression]) -> FunctionExpression
 
@@ -1099,8 +1090,7 @@ public protocol Expression: Sendable {
   /// Field("val1").logicalMinimum(0, -5.5)
   /// ```
   ///
-  /// - Parameter second: The second literal `Sendable` value to compare with.
-  /// - Parameter others: Optional additional literal `Sendable` values to compare with.
+  /// - Parameter values: An array of at least one `Sendable` value to compare with.
   /// - Returns: A new `FunctionExpression` representing the logical min operation.
   func logicalMinimum(_ values: [Sendable]) -> FunctionExpression
 

Firestore/Swift/Source/SwiftAPI/Pipeline/Pipeline.swift

@@ -135,8 +135,7 @@ public struct Pipeline: @unchecked Sendable {
   /// // let results = try await updatedPipeline.execute()
   /// ```
   ///
-  /// - Parameter fields: The fields to add to the documents, specified as an array of
-  /// `AliasedExpression`.
+  /// - Parameter fields: An array of at least one `AliasedExpression` to add to the documents.
   /// - Returns: A new `Pipeline` object with this stage appended.
   public func addFields(_ fields: [AliasedExpression]) -> Pipeline {
     return Pipeline(stages: stages + [AddFields(fields: fields)], db: db)
@@ -151,7 +150,7 @@ public struct Pipeline: @unchecked Sendable {
   /// // let results = try await updatedPipeline.execute()
   /// ```
   ///
-  /// - Parameter fields: An array of `Field` instances to remove.
+  /// - Parameter fields: An array of at least one `Field` instance to remove.
   /// - Returns: A new `Pipeline` object with this stage appended.
   public func removeFields(_ fields: [Field]) -> Pipeline {
     return Pipeline(
@@ -169,7 +168,7 @@ public struct Pipeline: @unchecked Sendable {
   /// // let results = try await updatedPipeline.execute()
   /// ```
   ///
-  /// - Parameter fields: An array of field names to remove.
+  /// - Parameter fields: An array of at least one field name to remove.
   /// - Returns: A new `Pipeline` object with this stage appended.
   public func removeFields(_ fields: [String]) -> Pipeline {
     return Pipeline(
@@ -200,8 +199,8 @@ public struct Pipeline: @unchecked Sendable {
   /// // let results = try await projectedPipeline.execute()
   /// ```
   ///
-  /// - Parameter selections: An array of `Selectable` expressions to include in the output
-  /// documents.
+  /// - Parameter selections: An array of at least one `Selectable` expression to include in the
+  /// output documents.
   /// - Returns: A new `Pipeline` object with this stage appended.
   public func select(_ selections: [Selectable]) -> Pipeline {
     return Pipeline(
@@ -221,7 +220,8 @@ public struct Pipeline: @unchecked Sendable {
   /// // let results = try await projectedPipeline.execute()
   /// ```
   ///
-  /// - Parameter selections: An array of field names to include in the output documents.
+  /// - Parameter selections: An array of at least one field name to include in the output
+  /// documents.
   /// - Returns: A new `Pipeline` object with this stage appended.
   public func select(_ selections: [String]) -> Pipeline {
     let selections = selections.map { Field($0) }
@@ -314,8 +314,7 @@ public struct Pipeline: @unchecked Sendable {
   /// // let results = try await distinctAuthorsGenresPipeline.execute()
   /// ```
   ///
-  /// - Parameter group: The name of the first field for distinct value combinations.
-  /// - Parameter additionalGroups: Optional additional field names.
+  /// - Parameter groups: An array of at least one field name for distinct value combinations.
   /// - Returns: A new `Pipeline` object with this stage appended.
   public func distinct(_ groups: [String]) -> Pipeline {
     let selections = groups.map { Field($0) }
@@ -344,8 +343,7 @@ public struct Pipeline: @unchecked Sendable {
   /// // let results = try await distinctPipeline.execute()
   /// ```
   ///
-  /// - Parameter group: The first `Selectable` expression to consider.
-  /// - Parameter additionalGroups: Optional additional `Selectable` expressions.
+  /// - Parameter groups: An array of at least one `Selectable` expression to consider.
   /// - Returns: A new `Pipeline` object with this stage appended.
   public func distinct(_ groups: [Selectable]) -> Pipeline {
     return Pipeline(stages: stages + [Distinct(groups: groups)], db: db)
@@ -377,7 +375,7 @@ public struct Pipeline: @unchecked Sendable {
   /// ```
   ///
   /// - Parameters:
-  ///   - accumulator: An array of at least one `AggregateWithAlias` expressions for calculations.
+  ///   - aggregates: An array of at least one `AliasedAggregate` expression for calculations.
   ///   - groups: Optional array of `Selectable` expressions for grouping. If `nil` or empty,
   /// aggregates across all documents.
   /// - Returns: A new `Pipeline` object with this stage appended.
@@ -446,7 +444,7 @@ public struct Pipeline: @unchecked Sendable {
   /// // let results = try await sortedPipeline.execute()
   /// ```
   ///
-  /// - Parameter orderings: An array of `Ordering` criteria.
+  /// - Parameter orderings: An array of at least one `Ordering` criterion.
   /// - Returns: A new `Pipeline` object with this stage appended.
   public func sort(_ orderings: [Ordering]) -> Pipeline {
     return Pipeline(stages: stages + [Sort(orderings: orderings)], db: db)
@@ -556,7 +554,7 @@ public struct Pipeline: @unchecked Sendable {
   /// // let results = try await combinedPipeline.execute()
   /// ```
   ///
-  /// - Parameter other: The other `Pipeline` whose documents will be unioned.
+  /// - Parameter other: An array of at least one `Pipeline` whose documents will be unioned.
   /// - Returns: A new `Pipeline` object with this stage appended.
   public func union(with other: Pipeline) -> Pipeline {
     return Pipeline(stages: stages + [Union(other: other)], db: db)