From 7b1b4d9302d9ce2a6592536a39c5cc1458c7393f Mon Sep 17 00:00:00 2001 From: Marcus Chiam Date: Thu, 16 Mar 2023 00:06:10 -0400 Subject: [PATCH] Fixed pop utility fn doc string --- flax/core/frozen_dict.py | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/flax/core/frozen_dict.py b/flax/core/frozen_dict.py index 37a3ad76aa..5500a24af8 100644 --- a/flax/core/frozen_dict.py +++ b/flax/core/frozen_dict.py @@ -245,7 +245,8 @@ def copy(x: Union[FrozenDict, Dict[str, Any]], add_or_replace: Union[FrozenDict, def pop(x: Union[FrozenDict, Dict[str, Any]], key: str) -> Tuple[Union[FrozenDict, Dict[str, Any]], Any]: """Create a new dict where one entry is removed. This is a utility - function for regular dicts that mimics the behavior of `FrozenDict.pop`. + function that can act on either a FrozenDict or regular dict and + mimics the behavior of `FrozenDict.pop`. Example::