-

cool-RR · cool-RR · commit 6c0a0c249a92 · 2014-01-24T16:57:42.000+02:00
diff --git a/source_py3/python_toolbox/monkeypatching_tools.py b/source_py3/python_toolbox/monkeypatching_tools.py
@@ -89,6 +89,17 @@ def decorator(function):
 
 
 def change_defaults(function=None, new_defaults={}):
+    '''
+    Change default values of a function.
+    
+    Include the new defaults in a dict `new_defaults`, with each key being a
+    keyword name and each value being the new default value.
+    
+    Note: This changes the actual function!
+    
+    Can be used both as a straight function and as a decorater to a function to
+    be changed.
+    '''
     def change_defaults_(function_, new_defaults_):
         signature = inspect.Signature.from_function(function_)
         defaults = list(function_.__defaults__ or ())
