Document UnicodeEncodeError

nineteendo · Nov 28, 2024 · c1bfd35 · c1bfd35
1 parent b88c506
commit c1bfd35
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 0 deletions.
diff --git a/src/jsonyx/__init__.py b/src/jsonyx/__init__.py
@@ -266,6 +266,7 @@ def write(
     :param trailing_comma: add a trailing comma when indented
     :raises RecursionError: if the object is too deeply nested
     :raises TypeError: for unserializable values
+    :raises UnicodeEncodeError: when failing to encode the file
     :raises ValueError: for invalid values
 
     Example:

diff --git a/src/jsonyx/_encoder.py b/src/jsonyx/_encoder.py
@@ -368,6 +368,7 @@ def write(self, obj: object, filename: _StrPath) -> None:
         :param filename: the path to the JSON file
         :raises RecursionError: if the object is too deeply nested
         :raises TypeError: for unserializable values
+        :raises UnicodeEncodeError: when failing to encode the file
         :raises ValueError: for invalid values
 
         Example: