Skip to content

Commit 70ea605

Browse files
ararslanararslan
committed
Fix documentation references
1 parent 086d47a commit 70ea605

File tree

4 files changed

+42
-39
lines changed

4 files changed

+42
-39
lines changed

‎docs/src/index.md

Lines changed: 32 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -6,38 +6,38 @@ libraries.
66

77
| Function | Description |
88
|:------------------------------------------------------------- |:--------------------------------------------------------------------------------------------------------------------------------------------------------------- |
9-
| [`erf(x)`](@ref) | [error function](https://en.wikipedia.org/wiki/Error_function) at `x` |
10-
| [`erfc(x)`](@ref) | complementary error function, i.e. the accurate version of `1-erf(x)` for large `x` |
11-
| [`erfinv(x)`](@ref) | inverse function to [`erf()`](@ref) |
12-
| `erfcinv(x)` | inverse function to [`erfc()`](@ref) |
13-
| [`erfi(x)`](@ref) | imaginary error function defined as `-im * erf(x * im)`, where [`im`](@ref) is the imaginary unit |
14-
| [`erfcx(x)`](@ref) | scaled complementary error function, i.e. accurate `exp(x^2) * erfc(x)` for large `x` |
15-
| [`dawson(x)`](@ref) | scaled imaginary error function, a.k.a. Dawson function, i.e. accurate `exp(-x^2) * erfi(x) * sqrt(pi) / 2` for large `x` |
16-
| [`digamma(x)`](@ref) | [digamma function](https://en.wikipedia.org/wiki/Digamma_function) (i.e. the derivative of [`lgamma()`](@ref)) at `x` |
17-
| [`eta(x)`](@ref) | [Dirichlet eta function](https://en.wikipedia.org/wiki/Dirichlet_eta_function) at `x` |
18-
| [`zeta(x)`](@ref) | [Riemann zeta function](https://en.wikipedia.org/wiki/Riemann_zeta_function) at `x` |
19-
| [`airyai(z)`](@ref) | [Airy Ai function](https://en.wikipedia.org/wiki/Airy_function) at `z` |
20-
| [`airyaiprime(z)`](@ref) | derivative of the Airy Ai function at `z` |
21-
| [`airybi(z)`](@ref) | [Airy Bi function](https://en.wikipedia.org/wiki/Airy_function) at `z` |
22-
| [`airybiprime(z)`](@ref) | derivative of the Airy Bi function at `z` |
23-
| [`airyaix(z)`](@ref), [`airyaiprimex(z)`](@ref), [`airybix(z)`](@ref), [`airybiprimex(z)`](@ref) | scaled Airy AI function and `k` th derivatives at `z` |
24-
| [`besselj(nu,z)`](@ref) | [Bessel function](https://en.wikipedia.org/wiki/Bessel_function) of the first kind of order `nu` at `z` |
25-
| [`besselj0(z)`](@ref) | `besselj(0,z)` |
26-
| [`besselj1(z)`](@ref) | `besselj(1,z)` |
27-
| [`besseljx(nu,z)`](@ref) | scaled Bessel function of the first kind of order `nu` at `z` |
28-
| [`bessely(nu,z)`](@ref) | [Bessel function](https://en.wikipedia.org/wiki/Bessel_function) of the second kind of order `nu` at `z` |
29-
| [`bessely0(z)`](@ref) | `bessely(0,z)` |
30-
| [`bessely1(z)`](@ref) | `bessely(1,z)` |
31-
| [`besselyx(nu,z)`](@ref) | scaled Bessel function of the second kind of order `nu` at `z` |
32-
| [`besselh(nu,k,z)`](@ref) | [Bessel function](https://en.wikipedia.org/wiki/Bessel_function) of the third kind (a.k.a. Hankel function) of order `nu` at `z`; `k` must be either `1` or `2` |
33-
| [`hankelh1(nu,z)`](@ref) | `besselh(nu, 1, z)` |
34-
| [`hankelh1x(nu,z)`](@ref) | scaled `besselh(nu, 1, z)` |
35-
| [`hankelh2(nu,z)`](@ref) | `besselh(nu, 2, z)` |
36-
| [`hankelh2x(nu,z)`](@ref) | scaled `besselh(nu, 2, z)` |
37-
| [`besseli(nu,z)`](@ref) | modified [Bessel function](https://en.wikipedia.org/wiki/Bessel_function) of the first kind of order `nu` at `z` |
38-
| [`besselix(nu,z)`](@ref) | scaled modified Bessel function of the first kind of order `nu` at `z` |
39-
| [`besselk(nu,z)`](@ref) | modified [Bessel function](https://en.wikipedia.org/wiki/Bessel_function) of the second kind of order `nu` at `z` |
40-
| [`besselkx(nu,z)`](@ref) | scaled modified Bessel function of the second kind of order `nu` at `z` |
9+
| [`erf(x)`](@ref SpecialFunctions.erf) | [error function](https://en.wikipedia.org/wiki/Error_function) at `x` |
10+
| [`erfc(x)`](@ref SpecialFunctions.erfc) | complementary error function, i.e. the accurate version of `1-erf(x)` for large `x` |
11+
| [`erfinv(x)`](@ref SpecialFunctions.erfinv) | inverse function to [`erf()`](@ref SpecialFunctions.erf) |
12+
| [`erfcinv(x)`](@ref SpecialFunctions.erfcinv) | inverse function to [`erfc()`](@ref SpecialFunctions.erfc) |
13+
| [`erfi(x)`](@ref SpecialFunctions.erfi) | imaginary error function defined as `-im * erf(x * im)`, where `im` is the imaginary unit |
14+
| [`erfcx(x)`](@ref SpecialFunctions.erfcx) | scaled complementary error function, i.e. accurate `exp(x^2) * erfc(x)` for large `x` |
15+
| [`dawson(x)`](@ref SpecialFunctions.dawson) | scaled imaginary error function, a.k.a. Dawson function, i.e. accurate `exp(-x^2) * erfi(x) * sqrt(pi) / 2` for large `x` |
16+
| [`digamma(x)`](@ref SpecialFunctions.digamma) | [digamma function](https://en.wikipedia.org/wiki/Digamma_function) (i.e. the derivative of `lgamma` at `x`) |
17+
| [`eta(x)`](@ref SpecialFunctions.eta) | [Dirichlet eta function](https://en.wikipedia.org/wiki/Dirichlet_eta_function) at `x` |
18+
| [`zeta(x)`](@ref SpecialFunctions.zeta) | [Riemann zeta function](https://en.wikipedia.org/wiki/Riemann_zeta_function) at `x` |
19+
| [`airyai(z)`](@ref SpecialFunctions.airyai) | [Airy Ai function](https://en.wikipedia.org/wiki/Airy_function) at `z` |
20+
| [`airyaiprime(z)`](@ref SpecialFunctions.airyaiprime) | derivative of the Airy Ai function at `z` |
21+
| [`airybi(z)`](@ref SpecialFunctions.airybi) | [Airy Bi function](https://en.wikipedia.org/wiki/Airy_function) at `z` |
22+
| [`airybiprime(z)`](@ref SpecialFunctions.airybiprime) | derivative of the Airy Bi function at `z` |
23+
| [`airyaix(z)`](@ref SpecialFunctions.airyaix), [`airyaiprimex(z)`](@ref SpecialFunctions.airyaiprimex), [`airybix(z)`](@ref SpecialFunctions.airybix), [`airybiprimex(z)`](@ref SpecialFunctions.airybiprimex) | scaled Airy Ai function and `k`th derivatives at `z` |
24+
| [`besselj(nu,z)`](@ref SpecialFunctions.besselj) | [Bessel function](https://en.wikipedia.org/wiki/Bessel_function) of the first kind of order `nu` at `z` |
25+
| [`besselj0(z)`](@ref SpecialFunctions.besselj0) | `besselj(0,z)` |
26+
| [`besselj1(z)`](@ref SpecialFunctions.besselj1) | `besselj(1,z)` |
27+
| [`besseljx(nu,z)`](@ref SpecialFunctions.besseljx) | scaled Bessel function of the first kind of order `nu` at `z` |
28+
| [`bessely(nu,z)`](@ref SpecialFunctions.bessely) | [Bessel function](https://en.wikipedia.org/wiki/Bessel_function) of the second kind of order `nu` at `z` |
29+
| [`bessely0(z)`](@ref SpecialFunctions.bessely0) | `bessely(0,z)` |
30+
| [`bessely1(z)`](@ref SpecialFunctions.bessely1) | `bessely(1,z)` |
31+
| [`besselyx(nu,z)`](@ref SpecialFunctions.besselyx) | scaled Bessel function of the second kind of order `nu` at `z` |
32+
| [`besselh(nu,k,z)`](@ref SpecialFunctions.besselh) | [Bessel function](https://en.wikipedia.org/wiki/Bessel_function) of the third kind (a.k.a. Hankel function) of order `nu` at `z`; `k` must be either `1` or `2` |
33+
| [`hankelh1(nu,z)`](@ref SpecialFunctions.hankelh1) | `besselh(nu, 1, z)` |
34+
| [`hankelh1x(nu,z)`](@ref SpecialFunctions.hankelh1x) | scaled `besselh(nu, 1, z)` |
35+
| [`hankelh2(nu,z)`](@ref SpecialFunctions.hankelh2) | `besselh(nu, 2, z)` |
36+
| [`hankelh2x(nu,z)`](@ref SpecialFunctions.hankelh2x) | scaled `besselh(nu, 2, z)` |
37+
| [`besseli(nu,z)`](@ref SpecialFunctions.besseli) | modified [Bessel function](https://en.wikipedia.org/wiki/Bessel_function) of the first kind of order `nu` at `z` |
38+
| [`besselix(nu,z)`](@ref SpecialFunctions.besselix) | scaled modified Bessel function of the first kind of order `nu` at `z` |
39+
| [`besselk(nu,z)`](@ref SpecialFunctions.besselk) | modified [Bessel function](https://en.wikipedia.org/wiki/Bessel_function) of the second kind of order `nu` at `z` |
40+
| [`besselkx(nu,z)`](@ref SpecialFunctions.besselkx) | scaled modified Bessel function of the second kind of order `nu` at `z` |
4141

4242
## Installation
4343

‎docs/src/special.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
# Functions
22

3+
```@meta
4+
CurrentModule = SpecialFunctions
5+
```
6+
37
```@docs
48
SpecialFunctions.erf
59
SpecialFunctions.erfc
@@ -39,6 +43,5 @@ SpecialFunctions.besselix
3943
SpecialFunctions.besselk
4044
SpecialFunctions.besselkx
4145
SpecialFunctions.eta
42-
SpecialFunctions.zeta(::Complex)
43-
SpecialFunctions.zeta(::Any, ::Any)
46+
SpecialFunctions.zeta
4447
```

‎src/bessel.jl

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ airybiprime(z::Complex128) = _biry(z, Int32(1), Int32(1))
7878
airyaix(x)
7979
8080
Scaled Airy function of the first kind ``\\operatorname{Ai}(x) e^{\\frac{2}{3} x
81-
\\sqrt{x}}``. Throws [`DomainError`](@ref) for negative `Real` arguments.
81+
\\sqrt{x}}``. Throws `DomainError` for negative `Real` arguments.
8282
"""
8383
function airyaix end
8484
airyaix(z::Complex128) = _airy(z, Int32(0), Int32(2))
@@ -87,7 +87,7 @@ airyaix(z::Complex128) = _airy(z, Int32(0), Int32(2))
8787
airyaiprimex(x)
8888
8989
Scaled derivative of the Airy function of the first kind ``\\operatorname{Ai}'(x)
90-
e^{\\frac{2}{3} x \\sqrt{x}}``. Throws [`DomainError`](@ref) for negative `Real` arguments.
90+
e^{\\frac{2}{3} x \\sqrt{x}}``. Throws `DomainError` for negative `Real` arguments.
9191
"""
9292
function airyaiprimex end
9393
airyaiprimex(z::Complex128) = _airy(z, Int32(1), Int32(2))

‎src/gamma.jl

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ using Base.MPFR: ROUNDING_MODE, big_ln2
1414
"""
1515
digamma(x)
1616
17-
Compute the digamma function of `x` (the logarithmic derivative of [`gamma(x)`](@ref)).
17+
Compute the digamma function of `x` (the logarithmic derivative of `gamma(x)`).
1818
"""
1919
function digamma(z::Union{Float64,Complex{Float64}})
2020
# Based on eq. (12), without looking at the accompanying source
@@ -54,7 +54,7 @@ end
5454
"""
5555
trigamma(x)
5656
57-
Compute the trigamma function of `x` (the logarithmic second derivative of [`gamma(x)`](@ref)).
57+
Compute the trigamma function of `x` (the logarithmic second derivative of `gamma(x)`).
5858
"""
5959
function trigamma(z::Union{Float64,Complex{Float64}})
6060
# via the derivative of the Kölbig digamma formulation
@@ -317,7 +317,7 @@ end
317317
polygamma(m, x)
318318
319319
Compute the polygamma function of order `m` of argument `x` (the `(m+1)th` derivative of the
320-
logarithm of [`gamma(x)`](@ref))
320+
logarithm of `gamma(x)`)
321321
"""
322322
function polygamma(m::Integer, z::Union{Float64,Complex{Float64}})
323323
m == 0 && return digamma(z)

0 commit comments

Comments
 (0)