From 91e895018318384b9a49ecc5635872a24bca3f7e Mon Sep 17 00:00:00 2001
From: Alex Fikl <alexfikl@gmail.com>
Date: Mon, 27 Sep 2021 10:24:34 -0500
Subject: [PATCH] improve docs for serialize_container
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
Co-authored-by: Andreas Klöckner <inform@tiker.net>
---
arraycontext/container/__init__.py | 5 +++--
1 file changed, 3 insertions(+), 2 deletions(-)
diff --git a/arraycontext/container/__init__.py b/arraycontext/container/__init__.py
index 23f980c..5383533 100644
--- a/arraycontext/container/__init__.py
+++ b/arraycontext/container/__init__.py
@@ -123,8 +123,9 @@ def serialize_container(ary: ArrayContainer) -> Iterable[Tuple[Any, Any]]:
The order of the components and their identifiers are entirely under
the control of the container class. However, the order is required to be
- deterministic, i.e. two calls to :func:`serialize_container` on the same
- array container should return an iterable with the components in the same
+ deterministic, i.e. two calls to :func:`serialize_container` on
+ array containers of the same types with the same number of
+ sub-arrays should result in an iterable with the keys in the same
order.
If *ary* is mutable, the serialization function is not required to ensure
--
GitLab