Update JacobiElliptic.jl documentation

dominic-chang · Feb 20, 2024 · 3441e97 · 3441e97
1 parent 511529d
commit 3441e97
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 8 deletions.
diff --git a/docs/src/index.md b/docs/src/index.md
@@ -13,7 +13,6 @@ JacobiElliptic is an implementation of Toshio Fukushima's algorithms for calcula
 
 ```@contents
 Pages = [
-    "index.md",
     "api.md"
 ]
 ```
diff --git a/src/JacobiElliptic.jl b/src/JacobiElliptic.jl
@@ -215,7 +215,7 @@ function serf(y::T, m::T) where T
 end
 
 """
-``\\text{asn}(u\\|\\,m)=\\text{sn}^{-1}(u,m)``.
+``\\text{asn}(u|\\,m)=\\text{sn}^{-1}(u,m)``.
 
 Returns the inverse Jacobi Elliptic sn.
 
@@ -241,7 +241,7 @@ function asn(s::T, m::T) where T
 end
 
 """
-``\\text{acn}(u\\|\\,m)=\\text{cn}^{-1}(u,m)``.
+``\\text{acn}(u|\\,m)=\\text{cn}^{-1}(u,m)``.
 
 Returns the inverse Jacobi Elliptic cn.
 
@@ -305,7 +305,7 @@ function _F(φ::T, m::T) where T
 end
 
 """
-``F(\\varphi \\|\\, m) = \\int_0^{\\varphi}\\frac{d\\theta}{\\sqrt{1-m\\sin(\\theta)^2}}.``
+``F(\\varphi |\\, m) = \\int_0^{\\varphi}\\frac{d\\theta}{\\sqrt{1-m\\sin(\\theta)^2}}.``
 
 Returns the incomplete elliptic integral of the first kind.
 
@@ -479,7 +479,7 @@ end
 #----------------------------------------------------------------------------------------
 
 """
-``E(\\varphi\\|\\, m) = \\int_0^{\\varphi}d\\theta \\sqrt{1-m\\sin(\\theta)^2}.``
+``E(\\varphi|\\, m) = \\int_0^{\\varphi}d\\theta \\sqrt{1-m\\sin(\\theta)^2}.``
 
 Returns the incomplete elliptic integral of the second kind.
 
@@ -1022,7 +1022,7 @@ function _SD(u::T, m::T) where T
 end
 
 """
-``\\text{sn}(u\\|\\,m)=\\sin\\,\\text{am}(u,m)``, where ``\\text{am}(u|\\,m)=F^{-1}(u|\\,m)`` 
+``\\text{sn}(u|\\,m)=\\sin\\,\\text{am}(u,m)``, where ``\\text{am}(u|\\,m)=F^{-1}(u|\\,m)`` 
 is the Jacobi amplitude.
 
 Returns the Jacobi Elliptic sn.
@@ -1041,7 +1041,7 @@ function sn(u::T, m::T) where T
 end
 
 """
-``\\text{cn}(u\\|\\,m)=\\cos\\,\\text{am}(u,m)``, where ``\\text{am}(u|\\,m)=F^{-1}(u|\\,m)`` 
+``\\text{cn}(u|\\,m)=\\cos\\,\\text{am}(u,m)``, where ``\\text{am}(u|\\,m)=F^{-1}(u|\\,m)`` 
 is the Jacobi amplitude.
 
 Returns the Jacobi Elliptic cn.
@@ -1059,7 +1059,7 @@ function cn(u::T, m::T) where T
 end
 
 """
-``\\text{dn}(u\\|\\,m)=\\frac{d}{d u}\\,\\text{am}(u,m)``, where ``\\text{am}(u|\\,m)=F^{-1}(u|\\,m)`` 
+``\\text{dn}(u|\\,m)=\\frac{d}{d u}\\,\\text{am}(u,m)``, where ``\\text{am}(u|\\,m)=F^{-1}(u|\\,m)`` 
 is the Jacobi amplitude.
 
 Returns the Jacobi Elliptic dn.