Skip to content

Commit f23f6f1

Browse files
authored
Address M150 Javadoc comments (#6093)
Per [b/352564349](https://b.corp.google.com/issues/352564349), This fixes the non blocking comments Rachel left in the m150 Javadoc CL.
1 parent ecea64b commit f23f6f1

File tree

2 files changed

+5
-7
lines changed

2 files changed

+5
-7
lines changed

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

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -134,17 +134,15 @@ class RequestTimeoutException(message: String, cause: Throwable? = null) :
134134
* The specified Vertex AI location is invalid.
135135
*
136136
* For a list of valid locations, see
137-
* [Vertex AI locations](https://cloud.google.com/vertex-ai/generative-ai/docs/learn/locations#available-regions)
138-
* .
137+
* [Vertex AI locations.](https://cloud.google.com/vertex-ai/generative-ai/docs/learn/locations#available-regions)
139138
*/
140139
class InvalidLocationException(location: String, cause: Throwable? = null) :
141140
FirebaseVertexAIException("Invalid location \"${location}\"", cause)
142141

143142
/**
144143
* The service is not enabled for this Firebase project. Learn how to enable the required services
145144
* in the
146-
* [Firebase documentation](https://firebase.google.com/docs/vertex-ai/faq-and-troubleshooting#required-apis)
147-
* .
145+
* [Firebase documentation.](https://firebase.google.com/docs/vertex-ai/faq-and-troubleshooting#required-apis)
148146
*/
149147
class ServiceDisabledException(message: String, cause: Throwable? = null) :
150148
FirebaseVertexAIException(message, cause)

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -182,7 +182,7 @@ class Schema<T>(
182182
fun fromString(value: String?) = type.parse(value)
183183

184184
companion object {
185-
/** Registers a schema for a 32 bit integer number */
185+
/** Registers a schema for a 32-bit integer number */
186186
fun int(name: String, description: String) =
187187
Schema<Int>(
188188
name = name,
@@ -192,7 +192,7 @@ class Schema<T>(
192192
nullable = false,
193193
)
194194

195-
/** Registers a schema for a 64 bit integer number */
195+
/** Registers a schema for a 64-bit integer number */
196196
fun long(name: String, description: String) =
197197
Schema<Long>(
198198
name = name,
@@ -221,7 +221,7 @@ class Schema<T>(
221221

222222
/** Registers a schema for a floating point number */
223223
@Deprecated(
224-
message = "this is being renamed to double",
224+
message = "Use `double` instead.",
225225
replaceWith = ReplaceWith("double(name, description)"),
226226
)
227227
fun num(name: String, description: String) =

0 commit comments

Comments
 (0)