JuliaDynamics/DrWatson.jl

The examples in the document are inconsistent with the API interface

Open

#410 建立於 2024年4月9日

在 GitHub 查看
 (1 留言) (0 反應) (0 負責人)Julia (915 star) (94 fork)batch import
documentationgood first issue

描述

I'm so grateful to the authors for this great package, it helped me tremendously! But when I was reading the documentation recently, I found that the calling order of parameters in the sample code of produce_or_load was inconsistent with the API description. Documentation at https://juliadynamics.github.io/DrWatson.jl/stable/real_world/#Stopping-%22Did-I-run-this?%22. The example is given by

N = 2000; T = 2000.0
data, file = produce_or_load(
    datadir("mushrooms", "toy"), # path
    @dict(N, T), # container
    simulation; # function
    prefix = "fig5_toyparams" # prefix for savename
)
@unpack toypar_h = data

However, the definition of produce_or_load is given by

produce_or_load(f::Function, config, path = ""; kwargs...) -> data, file

Their parameter order is reversed, will this work fine either way?

貢獻者指南

技術棧
無
領域
documentation
議題類型
documentation
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
2
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
under 1 hour
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
needs maintainer response
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
needs investigation
前置要求
basic DrWatson package usage
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
70
研究方向
First, verify the correct parameter order for produce or load by examining its source code in the DrWatson.jl repository (likely in src/). The current documentation example shows the order (path, config, function) while the API signature shows (function, config, path). Confirm which order is intended and update either the example in the documentation file (e.g., docs/src/real world.md) or the API documentation accordingly. If the example is correct, the function signature comment in the source code may need correction.