Ticket #5538: family_review.patch

sage/sets/family.py

@@ -21 +21 @@
 from sage.rings.integer import Integer
 from sage.misc.misc import AttrCallObject
 from warnings import warn
-name_warn_message = "The keyword name for family has never been used and will be removed shortly. Please update your code."
+name_warn_message = "The keyword argument `name` for Family has never been implemented and will be removed shortly.\nPlease update your code to use f=Family(...); f.rename(...)."
  
 def Family(indices, function = None, hidden_keys = [], hidden_function = None, lazy = False, name=None):
     r"""
@@ -157 +157 @@
        sage: f == loads(dumps(f))
        True
 
-    But this one don't::   
+    But this one does not::   
 
        sage: def plus_n(n): return lambda x: x+n
        sage: f = Family([1,2,3], plus_n(3), lazy=True); f
@@ -280 +280 @@
 
         sage: f = Family({1:'a', 2:'b', 3:'c'}, lazy=True)
         Traceback (most recent call last):
-        ValueError: lazy keyword only makes sense together with function keyword !
+        ValueError: `lazy` keyword parameter only makes sense together with `function` keyword parameter
         
     ::
     
@@ -320 +320 @@
 
     if hidden_keys == []:
         if hidden_function is not None:
-                raise ValueError, "hidden_function keyword only makes sense together with hidden_keys keyword !"            
+                raise ValueError, "`hidden_function` keyword parameter only makes sense together with `hidden_keys` keyword parameter"            
         elif function is None:
             if lazy:
-                raise ValueError, "lazy keyword only makes sense together with function keyword !"
+                raise ValueError, "`lazy` keyword parameter only makes sense together with `function` keyword parameter"
             if isinstance(indices, dict):
                 return FiniteFamily(indices)
             if isinstance(indices, (list, tuple) ):
@@ -339 +339 @@
             return LazyFamily(indices, function)            
     else:
         if lazy:
-            raise ValueError, "lazy keyword is incompatible with hidden keys !"
+            raise ValueError, "`lazy` and `hidden_keys` keyword parameters are mutually exclusive"
         if hidden_function is None:
             hidden_function = function
         return FiniteFamilyWithHiddenKeys(dict([(i, function(i)) for i in indices]),