Fix code remarks

lambdaworks · May 30, 2023 · c9b9590 · c9b9590
1 parent f09ba33
commit c9b9590
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 6 deletions.
diff --git a/modules/library/src/main/scala/zio/elasticsearch/ElasticQuery.scala b/modules/library/src/main/scala/zio/elasticsearch/ElasticQuery.scala
@@ -126,14 +126,14 @@ object ElasticQuery {
 
   /**
    * Constructs a type-safe instance of [[zio.elasticsearch.query.FunctionScore]] query with one or multiple
-   * [[zio.elasticsearch.query.FunctionScoreFunction]]
+   * [[zio.elasticsearch.query.FunctionScoreFunction]].
    *
    * @param functions
    *   [[zio.elasticsearch.query.FunctionScoreFunction]] functions that will be part of
    *   [[zio.elasticsearch.query.FunctionScore]] query
    * @return
    *   an instance of [[zio.elasticsearch.query.FunctionScore]] that represents the Function Score Query with functions
-   *   that are used to calculate score for result
+   *   that are used to calculate score for result.
    */
   final def functionScore[S: Schema](
     functions: FunctionScoreFunction[S]*
@@ -150,14 +150,14 @@ object ElasticQuery {
 
   /**
    * Constructs an instance of [[zio.elasticsearch.query.FunctionScore]] query with one or multiple
-   * [[zio.elasticsearch.query.FunctionScoreFunction]]
+   * [[zio.elasticsearch.query.FunctionScoreFunction]].
    *
    * @param functions
    *   [[zio.elasticsearch.query.FunctionScoreFunction]] functions that will be part of
    *   [[zio.elasticsearch.query.FunctionScore]] query
    * @return
    *   an instance of [[zio.elasticsearch.query.FunctionScore]] that represents the Function Score Query with functions
-   *   that are used to calculate score for result
+   *   that are used to calculate score for result.
    */
   final def functionScore(
     functions: FunctionScoreFunction[Any]*

diff --git a/modules/library/src/main/scala/zio/elasticsearch/query/FunctionScoreFunction.scala b/modules/library/src/main/scala/zio/elasticsearch/query/FunctionScoreFunction.scala
@@ -385,7 +385,7 @@ object FunctionScoreFunction {
    * [[zio.elasticsearch.query.WeightFunction]] score allows you to multiply the score by the provided `weight`.
    *
    * @param weight
-   *   the number you wish to multiply the score with
+   *   the non-negative number you wish to multiply the score with
    * @return
    *   an instance of [[zio.elasticsearch.query.WeightFunction]] that can be used to in
    *   [[zio.elasticsearch.query.FunctionScoreQuery]].

diff --git a/modules/library/src/main/scala/zio/elasticsearch/query/Queries.scala b/modules/library/src/main/scala/zio/elasticsearch/query/Queries.scala
@@ -444,7 +444,7 @@ sealed trait HasChildQuery[S]
    * limit, it is excluded from the search results.
    *
    * @param value
-   *   the [[scala.Int]] value for `minChildren` parameter
+   *   the whole number value for `minChildren` parameter
    * @return
    *   an instance of [[HasChildQuery]] enriched with the `minChildren` parameter.
    */