More pattern and rule related tweaks (#1125)

mathics/builtin/patterns/__init__.py

@@ -39,3 +39,6 @@
 
 The attributes 'Flat', 'Orderless', and 'OneIdentity' affect pattern matching.
 """
+
+# This tells documentation how to sort this module
+sort_order = "mathics.builtin.rules-and-patterns"

mathics/builtin/patterns/restrictions.py

@@ -4,7 +4,7 @@
 
 
 """
-from typing import Optional as OptionalType
+from typing import Optional as OptionalType, Tuple
 
 from mathics.core.atoms import Integer, Number, Rational, Real, String
 from mathics.core.attributes import A_HOLD_REST, A_PROTECTED
@@ -27,11 +27,11 @@ class Condition(BinaryOperator, PatternObject):
     <dl>
       <dt>'Condition[$pattern$, $expr$]'
       <dt>'$pattern$ /; $expr$'
-      <dd>places an additional constraint on $pattern$ that only
-        allows it to match if $expr$ evaluates to 'True'.
+      <dd>places an additional constraint on $pattern$ that only \
+          allows it to match if $expr$ evaluates to 'True'.
     </dl>
 
-    The controlling expression of a 'Condition' can use variables from
+    The controlling expression of a 'Condition' can use variables from \
     the pattern:
     >> f[3] /. f[x_] /; x>0 -> t
      = t
@@ -92,8 +92,8 @@ class PatternTest(BinaryOperator, PatternObject):
     <dl>
       <dt>'PatternTest[$pattern$, $test$]'
       <dt>'$pattern$ ? $test$'
-      <dd>constrains $pattern$ to match $expr$ only if the
-        evaluation of '$test$[$expr$]' yields 'True'.
+      <dd>constrains $pattern$ to match $expr$ only if the \
+          evaluation of '$test$[$expr$]' yields 'True'.
     </dl>
 
     >> MatchQ[3, _Integer?(#>0&)]
@@ -354,5 +354,5 @@ def yield_match(vars_2, rest):
         # except StopGenerator:
         #    pass
 
-    def get_match_count(self, vars_dict: OptionalType[dict] = None):
+    def get_match_count(self, vars_dict: OptionalType[dict] = None) -> Tuple[int, int]:
         return self.pattern.get_match_count(vars_dict)

mathics/builtin/patterns/rules.py

@@ -133,7 +133,7 @@ def eval_list(
         result = eval_dispatch_atom(rules, evaluation)
         return result
 
-    def eval_list(
+    def eval(
         self, rules: Expression, evaluation: Evaluation
     ) -> OptionalType[BaseElement]:
         """Dispatch[rules_]"""
@@ -354,7 +354,7 @@ class ReplaceList(Builtin):
         "reps": "`1` is not a valid replacement rule.",
         "rmix": "Elements of `1` are a mixture of lists and nonlists.",
     }
-    summary_text = "list of possible replacement results"
+    summary_text = "list possible replacement results"
 
     def eval(
         self,
@@ -462,7 +462,7 @@ def eval_list(
             return rules
 
         maxit = self.get_option(options, "MaxIterations", evaluation)
-        if maxit.is_numeric(evaluation):
+        if maxit is not None and maxit.is_numeric(evaluation):
             maxit = maxit.get_int_value()
         else:
             maxit = -1

mathics/core/element.py

@@ -304,7 +304,9 @@ def get_name(self):
 
         return ""
 
-    def get_option_values(self, evaluation, allow_symbols=False, stop_on_error=True):
+    def get_option_values(
+        self, evaluation: "Evaluation", allow_symbols=False, stop_on_error=True
+    ) -> Optional[dict]:
         pass
 
     def get_precision(self) -> Optional[int]:

mathics/core/expression.py

@@ -769,11 +769,11 @@ def get_mutable_elements(self) -> list:
         return list(self._elements)
 
     def get_option_values(
-        self, evaluation, allow_symbols=False, stop_on_error=True
+        self, evaluation: Evaluation, allow_symbols=False, stop_on_error=True
     ) -> Optional[dict]:
         """
         Build a dictionary of options from an expression.
-        For example Symbol("Integrate").get_option_values(evaluation, allow_symbols=True)
+        For example, Symbol("Integrate").get_option_values(evaluation, allow_symbols=True)
         will return a list of options associated to the definition of the symbol "Integrate".
         """
         options = self