Merge pull request #706 from Mathics3/latex_doc-tweaks

Latex doc tweaks

Author: rocky

mathics/builtin/specialfns/zeta.py

@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
 
 """
-Exponential Integral and Special Functions
+Zeta Functions and Polylogarithms
 """
 
 import mpmath
@@ -12,11 +12,13 @@
 
 class LerchPhi(_MPMathFunction):
     """
-    <url>:WMA link:https://reference.wolfram.com/language/ref/LerchPhi.html</url>
+    <url>
+    :WMA link:
+    https://reference.wolfram.com/language/ref/LerchPhi.html</url>
 
     <dl>
-    <dt>'LerchPhi[z,s,a]'
-        <dd>gives the Lerch transcendent Φ(z,s,a).
+      <dt>'LerchPhi[z,s,a]'
+      <dd>gives the Lerch transcendent Φ(z,s,a).
     </dl>
 
     >> LerchPhi[2, 3, -1.5]
@@ -30,7 +32,7 @@ class LerchPhi(_MPMathFunction):
     sympy_name = "lerchphi"
     summary_text = "Lerch's trascendental ϕ function"
 
-    def apply(self, z, s, a, evaluation):
+    def eval(self, z, s, a, evaluation):
         "%(name)s[z_, s_, a_]"
 
         py_z = z.to_python()
@@ -45,10 +47,12 @@ def apply(self, z, s, a, evaluation):
 
 class Zeta(_MPMathFunction):
     """
-    <url>:WMA link:https://reference.wolfram.com/language/ref/Zeta.html</url>
+    <url>
+    :WMA link:
+    https://reference.wolfram.com/language/ref/Zeta.html</url>
 
     <dl>
-    <dt>'Zeta[$z$]'
+      <dt>'Zeta[$z$]'
       <dd>returns the Riemann zeta function of $z$.
     </dl>
 
@@ -62,3 +66,6 @@ class Zeta(_MPMathFunction):
     summary_text = "Riemann's ζ function"
     sympy_name = "zeta"
     mpmath_name = "zeta"
+
+
+# TODO: PolyLog, ReimannSiegelTheta, ReimannSiegelZ, ReimannXi, ZetaZero

mathics/doc/latex_doc.py

@@ -325,8 +325,8 @@ def get_latex_escape_char(text):
 
 
 def latex_label_safe(s: str) -> str:
-    s = s.replace("\\$", "")
-    s = s.replace("$", "")
+    s = s.replace("\\$", "dollar-")
+    s = s.replace("$", "dollar-")
     return s
 
 
@@ -533,6 +533,17 @@ def __str__(self):
         return self.test
 
     def latex(self, doc_data: dict) -> str:
+        """
+        Produces the LaTeX-formatted fragment that corresponds the
+        test sequence and results for a single Builtin that has been run.
+
+        The key for doc_data is the part/chapter/section{/subsection} test number
+        and the value contains Result object data turned into a dictionary.
+
+        In partuclar, each test in the test sequence includes the, input test,
+        the result produced and any additional error output.
+        The LaTeX-formatted string fragment is returned.
+        """
         if self.key is None:
             return ""
         output_for_key = doc_data.get(self.key, None)