This is an automated email from the ASF dual-hosted git repository.
skrawcz pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/burr.git
The following commit(s) were added to refs/heads/main by this push:
new b9ee1292 Update serde.rst (#555)
b9ee1292 is described below
commit b9ee1292622a11253a5ad9a93872d0d1c0308800
Author: Mr Ruben <[email protected]>
AuthorDate: Wed Dec 31 22:00:11 2025 +0100
Update serde.rst (#555)
* Update serde.rst
As agreed here
https://github.com/apache/burr/issues/554
it would be helpful to mention some limitations/caveats.
* Update serde.rst
adds limitation note
---------
Co-authored-by: Stefan Krawczyk <[email protected]>
---
docs/concepts/serde.rst | 9 +++++++++
1 file changed, 9 insertions(+)
diff --git a/docs/concepts/serde.rst b/docs/concepts/serde.rst
index c2ad47bd..20ad7a92 100644
--- a/docs/concepts/serde.rst
+++ b/docs/concepts/serde.rst
@@ -19,6 +19,7 @@
.. _serde:
+
================================
Serialization / Deserialization
================================
@@ -130,3 +131,11 @@ Requirements for the serializer/deserializer functions:
1. The serializer function needs to return a dictionary.
2. Both function signatures needs to have a ``**kwargs`` parameter to
allow for custom arguments to be passed in. We advise namespacing the kwargs
provided to avoid conflicts with other serializers/deserializers.
+
+
+Limitations of State Serialization
+----------------------------------
+
+Currently, it is only possible to override the serialization and
deserialization behavior of individual fields within a state.
+Overriding the serialization of the entire state object as a whole is not
supported at this time.
+If you need custom handling, you must apply it at the field level.
