Merge pull request #1505 from mathics/doc-abstracts

Start adding builtin summary texts

Author: rocky

mathics/builtin/arithfns/basic.py

@@ -87,6 +87,8 @@ class CubeRoot(Builtin):
         ),
     }
 
+    summary_text = "cubed root"
+
     def apply(self, n, evaluation):
         "CubeRoot[n_Complex]"
 
@@ -155,6 +157,8 @@ class Divide(BinaryOperator):
         ),
     }
 
+    summary_text = r"division"
+
 
 class Minus(PrefixOperator):
     """
@@ -192,6 +196,8 @@ class Minus(PrefixOperator):
         ),
     }
 
+    summary_text = "arithmetic negation"
+
     def apply_int(self, x, evaluation):
         "Minus[x_Integer]"
 
@@ -273,6 +279,7 @@ class Plus(BinaryOperator, SympyFunction):
         None: "0",
     }
 
+    summary_text = "addition of numbers, lists, arrays, or symbolic expressions"
     sympy_name = "Add"
 
     def format_plus(self, items, evaluation):
@@ -536,6 +543,8 @@ class Power(BinaryOperator, _MPMathFunction):
         "Power[x_]": "x",
     }
 
+    summary_text = "exponentiation"
+
     def apply_check(self, x, y, evaluation):
         "Power[x_, y_]"
 
@@ -603,6 +612,8 @@ class Sqrt(SympyFunction):
         ),
     }
 
+    summary_text = "square root"
+
 
 class Subtract(BinaryOperator):
     """
@@ -632,6 +643,8 @@ class Subtract(BinaryOperator):
         "Subtract[x_, y_]": "Plus[x, Times[-1, y]]",
     }
 
+    summary_text = "subtraction"
+
 
 class Times(BinaryOperator, SympyFunction):
     """
@@ -731,11 +744,13 @@ class Times(BinaryOperator, SympyFunction):
 
     default_formats = False
 
-    sympy_name = "Mul"
+    formats = {}
 
     rules = {}
 
-    formats = {}
+    sympy_name = "Mul"
+
+    summary_text = "mutiplication"
 
     def format_times(self, items, evaluation, op="\u2062"):
         "Times[items__]"

mathics/builtin/datentime.py

@@ -757,6 +757,8 @@ class AbsoluteTime(_DateFormat):
      = 1000
     """
 
+    abstract = "absolute time in seconds"
+
     def apply_now(self, evaluation):
         "AbsoluteTime[]"
 

mathics/builtin/list/associations.py

@@ -88,6 +88,8 @@ class Association(Builtin):
         "Protected",
     )
 
+    summary_text = "an association between keys and values"
+
     def apply_makeboxes(self, rules, f, evaluation):
         """MakeBoxes[<|rules___|>,
         f:StandardForm|TraditionalForm|OutputForm|InputForm]"""
@@ -179,8 +181,11 @@ class AssociationQ(Test):
 
     >> AssociationQ[<|a, b|>]
      = False
+
     """
 
+    summary_text = "test if an expression is a valid association"
+
     def test(self, expr):
         def validate(leaves):
             for leaf in leaves:
@@ -263,6 +268,8 @@ class Keys(Builtin):
         "invrl": "The argument `1` is not a valid Association or a list of rules.",
     }
 
+    summary_text = "list association keys"
+
     def apply(self, rules, evaluation):
         "Keys[rules___]"
 
@@ -291,8 +298,8 @@ def get_keys(expr):
 class Lookup(Builtin):
     """
     <dl>
-    <dt>Lookup[$assoc$, $key$]
-        <dd> looks up the value associated with $key$ in the association $assoc$, or Missing[$KeyAbsent$].
+      <dt>Lookup[$assoc$, $key$]
+      <dd> looks up the value associated with $key$ in the association $assoc$, or Missing[$KeyAbsent$].
     </dl>
     """
 
@@ -302,6 +309,8 @@ class Lookup(Builtin):
         "Lookup[assoc_?AssociationQ, key_]": 'Lookup[assoc, key, Missing["KeyAbsent", key]]',
     }
 
+    summary_text = "perform lookup of a value by key, returning a specified default if it is not found"
+
 
 class Missing(Builtin):
     pass
@@ -374,6 +383,8 @@ class Values(Builtin):
         "invrl": "The argument `1` is not a valid Association or a list of rules.",
     }
 
+    summary_text = "list association values"
+
     def apply(self, rules, evaluation):
         "Values[rules___]"