Skip to content

Commit c7fc048

Browse files
committed
More trig docstring cleanout
1 parent 6ba3b97 commit c7fc048

File tree

2 files changed

+6
-45
lines changed

2 files changed

+6
-45
lines changed

base/docs/helpdb/Base.jl

-42
Original file line numberDiff line numberDiff line change
@@ -976,13 +976,6 @@ seeding.
976976
"""
977977
srand
978978

979-
"""
980-
acot(x)
981-
982-
Compute the inverse cotangent of `x`, where the output is in radians.
983-
"""
984-
acot
985-
986979
"""
987980
oftype(x, y)
988981
@@ -2640,13 +2633,6 @@ Get the concrete type of `x`.
26402633
"""
26412634
typeof
26422635

2643-
"""
2644-
acsc(x)
2645-
2646-
Compute the inverse cosecant of `x`, where the output is in radians
2647-
"""
2648-
acsc
2649-
26502636
"""
26512637
log(x)
26522638
@@ -3059,13 +3045,6 @@ Element-wise less-than-or-equals comparison operator.
30593045
"""
30603046
Base.:(.<=)
30613047

3062-
"""
3063-
asec(x)
3064-
3065-
Compute the inverse secant of `x`, where the output is in radians.
3066-
"""
3067-
asec
3068-
30693048
"""
30703049
rank(M)
30713050
@@ -4925,13 +4904,6 @@ recurses infinitely.
49254904
"""
49264905
StackOverflowError
49274906

4928-
"""
4929-
acsch(x)
4930-
4931-
Compute the inverse hyperbolic cosecant of `x`.
4932-
"""
4933-
acsch
4934-
49354907
"""
49364908
process_running(p::Process)
49374909
@@ -5689,13 +5661,6 @@ Read a UDP packet from the specified socket, and return the bytes received. This
56895661
"""
56905662
recv
56915663

5692-
"""
5693-
acoth(x)
5694-
5695-
Compute the inverse hyperbolic cotangent of `x`.
5696-
"""
5697-
acoth
5698-
56995664
"""
57005665
det(M)
57015666
@@ -6038,13 +6003,6 @@ the integrity and correctness of data read from `stream`.
60386003
"""
60396004
deserialize
60406005

6041-
"""
6042-
asech(x)
6043-
6044-
Compute the inverse hyperbolic secant of `x`.
6045-
"""
6046-
asech
6047-
60486006
"""
60496007
ismarked(s)
60506008

base/special/trig.jl

+6-3
Original file line numberDiff line numberDiff line change
@@ -319,10 +319,13 @@ for (finv, f) in ((:sec, :cos), (:csc, :sin), (:cot, :tan),
319319
end
320320
end
321321

322-
for (fa, fainv) in ((:asec, :acos), (:acsc, :asin), (:acot, :atan),
323-
(:asech, :acosh), (:acsch, :asinh), (:acoth, :atanh))
322+
for (fa, fainv, fn) in ((:asec, :acos, "secant"), (:acsc, :asin, "cosecant"), (:acot, :atan, "cotangent"),
323+
(:asech, :acosh, "hyperbolic secant"), (:acsch, :asinh, "hyperbolic cosecant"), (:acoth, :atanh, "hyperbolic cotangent"))
324+
name = string(fa)
324325
@eval begin
325-
($fa){T<:Number}(y::T) = ($fainv)(one(T) / y)
326+
@doc """
327+
$($name)(x)
328+
Compute the $($fn) of `x`, where the output is in radians. """ ($fa){T<:Number}(y::T) = ($fainv)(one(T) / y)
326329
($fa){T<:Number}(y::AbstractArray{T}) = ($fainv)(one(T) ./ y)
327330
end
328331
end

0 commit comments

Comments
 (0)