JuliaDynamics/DrWatson.jl

The examples in the document are inconsistent with the API interface

オープン

#410 opened on 2024/04/09

 (1 件のコメント) (0 件のリアクション) (0 人の担当者)Julia (94 件のフォーク)batch import
documentationgood first issue

Repository metrics

Stars
 (915 個のスター)
PR merge metrics
 (30d に merged 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?

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