JuliaDocs/Documenter.jl

Add option to `doctest` individual functions

Open

#1,213 opened on 2019年12月12日

GitHub で見る
 (2 comments) (4 reactions) (0 assignees)Julia (513 forks)batch import
Type: Enhancementhelp wanted

Repository metrics

Stars
 (910 stars)
PR merge metrics
 (平均マージ 16d 9h) (30d で 3 merged PRs)

説明

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.

コントリビューターガイド