Add documentation #47
Conversation
Codecov ReportBase: 95.23% // Head: 95.23% // No change to project coverage 👍
Additional details and impacted files@@ Coverage Diff @@
## master #47 +/- ##
=======================================
Coverage 95.23% 95.23%
=======================================
Files 1 1
Lines 21 21
=======================================
Hits 20 20
Misses 1 1
Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. ☔ View full report at Codecov. |
src/Tau.jl
Outdated
| """ | ||
| sinτ(x) | ||
| sintau(x) | ||
|
|
||
| Compute ``\\sin(\\tau x)`` more accurately than `sin(tau*x)`, especially for large `x`. | ||
|
|
||
| See also: `costau`, `sincostau`. | ||
| """ | ||
| function sintau end |
There was a problem hiding this comment.
Note that we cannot find documentation for sinτ.
help?> sintau
search: sintau sincostau isinteractive
sinτ(x)
sintau(x)
Compute \sin(\tau x) more accurately than sin(tau*x), especially for large x.
See also: costau, sincostau.
help?> sinτ
"sinτ" can be typed by sin\tau<tab>
search: sinτ sincosτ sinh sind sinc sin sinpi sincos sintau sincosd sincospi sincostau using isinf asinh asind asin isinteger isinteractive thisind sign signed Signed signbit significand islink isfinite occursin Unsigned unsigned missing Missing lastindex MissingException VERSION versioninfo
No documentation found.
Tau.sinτ is a Function.
I think sinτ should be removed (#49), so removing sinτ in the docstring would be better.
| """ | |
| sinτ(x) | |
| sintau(x) | |
| Compute ``\\sin(\\tau x)`` more accurately than `sin(tau*x)`, especially for large `x`. | |
| See also: `costau`, `sincostau`. | |
| """ | |
| function sintau end | |
| """ | |
| sintau(x) | |
| Compute ``\\sin(\\tau x)`` more accurately than `sin(tau*x)`, especially for large `x`. | |
| See also: `costau`, `sincostau`. | |
| """ | |
| function sintau end |
There was a problem hiding this comment.
Seems to work as expected with the latest commit (c0eb021), apparently one has to add the docstring to the "original" function, not its alias.
Fixes #43.