Extend docstring to make it clear why json isn't printed and that it …

…is available
google · Aug 16, 2023 · 6986123 · 6986123
1 parent cc5edb5
commit 6986123
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/built_value/lib/serializer.dart b/built_value/lib/serializer.dart
@@ -375,6 +375,9 @@ abstract class StructuredSerializer<T> implements Serializer<T> {
 }
 
 /// [Error] conveying why deserialization failed.
+///
+/// The Object that failed to deseralize is included as [json] but is not displayed
+/// in the error message to prevent accidental inclusion in logs.
 class DeserializationError extends Error {
   final String? json;
   final FullType type;