Merge pull request #2958 from chiamp:pop_doc_str

PiperOrigin-RevId: 519817606
google · Mar 27, 2023 · 8957389 · 8957389
2 parents 396edea + 7b1b4d9
commit 8957389
Showing 1 changed file with 2 additions and 1 deletion.
diff --git 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::