Clarify example for SerializationException (#2806)

Kotlin · Sep 18, 2024 · 21311a6 · 21311a6
1 parent 2f1dbdb
commit 21311a6
Showing 1 changed file with 4 additions and 2 deletions.
diff --git a/core/commonMain/src/kotlinx/serialization/SerializationExceptions.kt b/core/commonMain/src/kotlinx/serialization/SerializationExceptions.kt
@@ -22,12 +22,14 @@ import kotlinx.serialization.descriptors.*
  * It is also an established pattern to validate input in user's classes in the following manner:
  * ```
  * @Serializable
- * class Foo(...) {
+ * class User(val age: Int, val name: String) {
  *     init {
- *         required(age > 0) { ... }
+ *         require(age > 0) { ... }
  *         require(name.isNotBlank()) { ... }
  *     }
  * }
+ *
+ * Json.decodeFromString<User>("""{"age": -100, "name": ""}""") // throws IllegalArgumentException from require()
  * ```
  * While clearly being serialization error (when compromised data was deserialized),
  * Kotlin way is to throw `IllegalArgumentException` here instead of using library-specific `SerializationException`.