Skip to content

Commit b74965e

Browse files
Apply suggestions from code review
Co-authored-by: rachelsaunders <[email protected]>
1 parent 570c974 commit b74965e

File tree

1 file changed

+5
-5
lines changed
  • firebase-vertexai/src/main/kotlin/com/google/firebase/vertexai/type

1 file changed

+5
-5
lines changed

firebase-vertexai/src/main/kotlin/com/google/firebase/vertexai/type/Schema.kt

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ public abstract class StringFormat private constructor(internal val value: Strin
2626
* These types can be objects, but also primitives and arrays. Represents a select subset of an
2727
* [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema).
2828
*
29-
* **Note:** while optional, including a the `description` field in your `Schema`s is strongly
29+
* **Note:** While optional, including a `description` field in your `Schema` is strongly
3030
* encouraged. The more information the model has about what it's expected to generate, the better
3131
* the results.
3232
*/
@@ -63,7 +63,7 @@ internal constructor(
6363
*
6464
* **Important:** This [Schema] provides a hint to the model that it should generate a 32-bit
6565
* integer, but only guarantees that the value will be an integer. Therefore it's *possible*
66-
* that decoding it as an `Int` variable, `int` in Java, could overflow.
66+
* that decoding it as an `Int` variable (or `int` in Java) could overflow.
6767
*
6868
* @param description An optional description of what the integer should contain or represent.
6969
* @param nullable Indicates whether the value can be `null`. Defaults to `false`.
@@ -112,7 +112,7 @@ internal constructor(
112112
*
113113
* **Important:** This [Schema] provides a hint to the model that it should generate a
114114
* single-precision floating-point number, but only guarantees that the value will be a number.
115-
* Therefore it's *possible* that decoding it as a `Float` variable, `float` in Java, could
115+
* Therefore it's *possible* that decoding it as a `Float` variable (or `float` in Java) could
116116
* overflow.
117117
*
118118
* @param description An optional description of what the number should contain or represent.
@@ -152,7 +152,7 @@ internal constructor(
152152
* This schema instructs the model to produce data of type object, which has keys of type
153153
* `String` and values of type [Schema].
154154
*
155-
* **Example:** A `City` could be represented with the following object `Schema`.
155+
* **Example:** A `city` could be represented with the following object `Schema`.
156156
* ```
157157
* Schema.obj(mapOf(
158158
* "name" to Schema.string(),
@@ -191,7 +191,7 @@ internal constructor(
191191
/**
192192
* Returns a [Schema] for an array.
193193
*
194-
* @param item The [Schema] of the elements of stored in the array.
194+
* @param item The [Schema] of the elements stored in the array.
195195
* @param description An optional description of what the array represent.
196196
* @param nullable Indicates whether the value can be `null`. Defaults to `false`.
197197
*/

0 commit comments

Comments
 (0)