JuliaDocs/Documenter.jl

Easier doctests of non-exported functions

Open

#2,126 创建于 2023年5月21日

在 GitHub 查看
 (9 评论) (0 反应) (0 负责人)Julia (910 star) (513 fork)batch import
Topic: UsabilityType: Enhancementhelp wanted

描述

Hello,

I've recently started adding more doctests to unexported functions in my code, and I seem to be repeating the same boilerplate-y setup quite a bit, e.g.

"""
    parsechecksum(checksum::String)
    
...text...

```jldoctest; setup = :(import DataToolkitCommon.Store.parsechecksum)
julia> parsechecksum("crc32c:9c0188ee")
(:crc32c, 0x9c0188ee)
```
"""

Is there some way this boilerplate could be avoided?

贡献者指南

技术栈
无
领域
documentationtesting
议题类型
feature
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
3
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
half day
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
fresh
清晰度议题是否清楚说明期望改动、验收标准和下一步。
clear
前置要求
Julia programmingDocumenter.jl basicsDoctest setup mechanics
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
70
研究方向
Explore the codebase for how doctests are processed, likely in src/DocHelpers.jl or src/doctests.jl. Consider adding a keyword argument or configuration to allow automatic import of the module's functions. Review comments in the issue for potential approaches discussed.
Easier doctests of non-exported functions · JuliaDocs/Documenter.jl#2126 | Good First Issue