Merge pull request #1446 from mathics/doc-fixes

Address misc doc issues

Author: rocky

mathics/builtin/compilation.py

@@ -1,4 +1,11 @@
 # -*- coding: utf-8 -*-
+"""Code Compilation
+
+Code compilation allows Mathics functions to be run faster.
+
+When LLVM and Python libraries are available, compilation produces LLVM code.
+"""
+
 
 import ctypes
 
@@ -21,9 +28,10 @@
 class Compile(Builtin):
     """
     <dl>
-    <dt>'Compile[{$x1$, $x2$, ...}, $expr$]'
+      <dt>'Compile[{$x1$, $x2$, ...}, $expr$]'
       <dd>Compiles $expr$ assuming each $xi$ is a $Real$ number.
-    <dt>'Compile[{{$x1$, $t1$} {$x2$, $t1$} ...}, $expr$]'
+
+      <dt>'Compile[{{$x1$, $t1$} {$x2$, $t1$} ...}, $expr$]'
       <dd>Compiles assuming each $xi$ matches type $ti$.
     </dl>
 

mathics/builtin/numeric.py

@@ -1187,11 +1187,9 @@ def test(expr):
 
 
 class RealValuedNumericQ(Builtin):
-    """
-    #> Internal`RealValuedNumericQ /@ {1, N[Pi], 1/2, Sin[1.], Pi, 3/4, aa,  I}
-     = {True, True, True, True, True, True, False, False}
-    """
-
+    # No docstring since this is internal and it will mess up documentation.
+    # FIXME: Perhaps in future we will have a more explicite way to indicate not
+    # to add something to the docs.
     context = "Internal`"
 
     rules = {
@@ -1200,11 +1198,9 @@ class RealValuedNumericQ(Builtin):
 
 
 class RealValuedNumberQ(Builtin):
-    """
-    #>  Internal`RealValuedNumberQ /@ {1, N[Pi], 1/2, Sin[1.], Pi, 3/4, aa, I}
-     = {True, True, True, True, False, True, False, False}
-    """
-
+    # No docstring since this is internal and it will mess up documentation.
+    # FIXME: Perhaps in future we will have a more explicite way to indicate not
+    # to add something to the docs.
     context = "Internal`"
 
     rules = {

test/test_numeric.py

@@ -2,6 +2,20 @@
 from .helper import check_evaluation
 
 
+def test_realvalued():
+    for str_expr, str_expected in (
+        (
+            "Internal`RealValuedNumberQ /@ {1, N[Pi], 1/2, Sin[1.], Pi, 3/4, aa, I}",
+            "{True, True, True, True, False, True, False, False}",
+        ),
+        (
+            "Internal`RealValuedNumericQ /@ {1, N[Pi], 1/2, Sin[1.], Pi, 3/4, aa,  I}",
+            "{True, True, True, True, True, True, False, False}",
+        ),
+    ):
+        check_evaluation(str_expr, str_expected)
+
+
 def test_realdigits():
     for str_expr, str_expected in (
         (