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