From 757e2f2397fb0236992705e1ca6fa696bdfb0dab Mon Sep 17 00:00:00 2001 From: joncrall Date: Thu, 29 Jun 2023 12:33:44 -0400 Subject: [PATCH] Update docs --- ubelt/util_cache.py | 3 +++ ubelt/util_dict.py | 4 ++++ 2 files changed, 7 insertions(+) diff --git a/ubelt/util_cache.py b/ubelt/util_cache.py index c37f7c27f..aa1d005bf 100644 --- a/ubelt/util_cache.py +++ b/ubelt/util_cache.py @@ -179,6 +179,9 @@ class Cacher(object): cfgstr (str | None): Deprecated in favor of ``depends``. + Related: + ..[JobLibMemory] https://joblib.readthedocs.io/en/stable/memory.html + Example: >>> import ubelt as ub >>> depends = 'repr-of-params-that-uniquely-determine-the-process' diff --git a/ubelt/util_dict.py b/ubelt/util_dict.py index ea362eceb..03f87348c 100644 --- a/ubelt/util_dict.py +++ b/ubelt/util_dict.py @@ -1033,6 +1033,9 @@ class SetDict(dict): from all dictionaries where the key appears an odd number of times. Rightmost values take priority. + The full set of set operations was originally rejected in [Pep584]_, but + this module seeks to address some of these concerns. + Note: The reason righmost values take priority in union / symmetric_difference and left-most values take priority in intersection @@ -1065,6 +1068,7 @@ class SetDict(dict): References: .. [RubyMerge] https://ruby-doc.org/core-2.7.0/Hash.html#method-i-merge + .. [Pep584] https://peps.python.org/pep-0584/#what-about-the-full-set-api CommandLine: xdoctest -m ubelt.util_dict SetDict