add little comment to explain utility functions

AntaresSimulatorTeam · Sep 17, 2024 · fca691a · fca691a
1 parent 7815a80
commit fca691a
Showing 1 changed file with 5 additions and 1 deletion.
diff --git a/antarest/core/serialization/utils.py b/antarest/core/serialization/utils.py
@@ -15,7 +15,11 @@
 
 ADAPTER: pydantic.TypeAdapter[t.Any] = pydantic.TypeAdapter(
     type=t.Any, config=pydantic.config.ConfigDict(ser_json_inf_nan="constants")
-)
+)  # ser_json_inf_nan="constants" means infinity and NaN values will be serialized as `Infinity` and `NaN`.
+
+
+# These utility functions allow to serialize with pydantic instead of using the built-in python "json" library.
+# Since pydantic v2 is written in RUST it's way faster.
 
 
 def from_json(data: t.Union[str, bytes, bytearray]) -> t.Dict[str, t.Any]: