improve error messages about custom key makers

lonelyenvoy · lonelyenvoy · commit 0f047a1f1cb3 · 2021-07-28T19:51:18.000+08:00
diff --git a/memoization/memoization.py b/memoization/memoization.py
@@ -110,7 +110,8 @@ def calculate_performance(employee):
                     custom_key_maker_info.defaults != user_function_info.defaults or \
                     custom_key_maker_info.kwonlydefaults != user_function_info.kwonlydefaults:
                 warnings.warn('Expected custom_key_maker to have the same signature as the function being cached. '
-                              'Call memoization.suppress_warnings() to remove this message.', SyntaxWarning)
+                              'Call memoization.suppress_warnings() before using @cached to remove this message.',
+                              SyntaxWarning)
 
         def custom_key_maker_wrapper(args, kwargs):
             return custom_key_maker(*args, **kwargs)
@@ -127,6 +128,7 @@ def custom_key_maker_wrapper(args, kwargs):
 def suppress_warnings(should_warn=False):
     """
     Disable/Enable warnings when @cached is used
+    Must be called before using @cached
 
     :param should_warn: Whether warnings should be shown (False by default)
     """
