JuliaDynamics/DrWatson.jl

The examples in the document are inconsistent with the API interface

开放

#410 创建于 2024年4月9日

 (1 条评论) (0 个反应) (0 位负责人)Julia (94 个派生)batch import
documentationgood first issue

仓库指标

星标
 (915 个星标)
PR 合并指标
 (30 天内没有已合并 PR)

描述

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?

贡献者指南