]> gitweb.michael.orlitzky.com - sage.d.git/commitdiff
Add a test for the empty product.
authorMichael Orlitzky <michael@orlitzky.com>
Tue, 4 Dec 2012 23:50:41 +0000 (18:50 -0500)
committerMichael Orlitzky <michael@orlitzky.com>
Tue, 4 Dec 2012 23:50:41 +0000 (18:50 -0500)
Add some backticks.

mjo/misc.py

index 8f50de32a23f90f8ce937a46fb2bb342450237e2..061a5090fe96741c965f96b1f13f66e6551a4b18 100644 (file)
@@ -5,20 +5,22 @@ Stuff that doesn't fit anywhere else.
 from sage.all import *
 from functools import reduce
 
+
 def legend_latex(obj):
     """
-    Return the LaTeX representation of `obj`, but wrap it in dollar
+    Return the LaTeX representation of ``obj``, but wrap it in dollar
     ($) signs so that we can pass it directly to plot() et al. as a
     legend label.
     """
     return '$%s$' % latex(obj)
 
+
 def product(factors):
     """
-    Returns the product of the elements in the list `factors`. If the
-    list is empty, we return 1.
+    Returns the product of the elements in the list ``factors``. If
+    the list is empty, we return 1.
 
-    TESTS:
+    EXAMPLES:
 
     Normal integer multiplication::
 
@@ -31,5 +33,12 @@ def product(factors):
         sage: product([x,y,z])
         x*y*z
 
+    TESTS:
+
+    The empty product is the multiplicative identity (one)::
+
+        sage: product([])
+        1
+
     """
     return reduce(operator.mul, factors, 1)