JuliaDocs/Documenter.jl
Ver no GitHubAdd option to `doctest` individual functions
Open
#1.213 aberto em 12 de dez. de 2019
Type: Enhancementhelp wanted
Métricas do repositório
- Stars
- (910 stars)
- Métricas de merge de PR
- (Mesclagem média 16d 9h) (3 fundiu PRs em 30d)
Description
It'd be nice if one could do something the following at the REPL:
julia> begin
"""
f(x)
add `1` to `x`
```jldoctest
julia> f(1)
2
```
"""
f(x) = x + 1
end
f
julia> doctest(f)
┌ Info: Testing the documentation for f: total 1 test
└ Test passed!
true
This way, one can use the doctest functionality without having to do all the other things documenter seems to require like having the function in a package, making doc directories, etc.