From 853f50147736df7f94a3d3ccf19253a0bafa28d7 Mon Sep 17 00:00:00 2001
From: Alex Fikl <alexfikl@gmail.com>
Date: Wed, 6 Oct 2021 19:13:53 -0500
Subject: [PATCH] improve docs
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 | 2 +-
arraycontext/container/traversal.py | 2 +-
2 files changed, 2 insertions(+), 2 deletions(-)
diff --git a/arraycontext/container/__init__.py b/arraycontext/container/__init__.py
index 5383533..4c93d52 100644
--- a/arraycontext/container/__init__.py
+++ b/arraycontext/container/__init__.py
@@ -125,7 +125,7 @@ def serialize_container(ary: ArrayContainer) -> Iterable[Tuple[Any, Any]]:
the control of the container class. However, the order is required to be
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
+ sub-arrays must result in an iterable with the keys in the same
order.
If *ary* is mutable, the serialization function is not required to ensure
diff --git a/arraycontext/container/traversal.py b/arraycontext/container/traversal.py
index 8cbd470..c951073 100644
--- a/arraycontext/container/traversal.py
+++ b/arraycontext/container/traversal.py
@@ -554,7 +554,7 @@ def flatten(ary: ArrayOrContainerT, actx: ArrayContext) -> Any:
def unflatten(
template: ArrayOrContainerT, ary: Any,
actx: ArrayContext) -> ArrayOrContainerT:
- """Unflatten an array produced by :func:`flatten` back into an
+ """Unflatten an array *ary* produced by :func:`flatten` back into an
:class:`~arraycontext.ArrayContainer`.
The order and sizes of each slice into *ary* are determined by the
--
GitLab