JuliaDynamics/DrWatson.jl

The examples in the document are inconsistent with the API interface

Open

#410 geöffnet am 9. Apr. 2024

Auf GitHub ansehen
 (1 Kommentar) (0 Reaktionen) (0 zugewiesene Personen)Julia (94 Forks)batch import
documentationgood first issue

Repository-Metriken

Stars
 (915 Stars)
PR-Merge-Metriken
 (Keine gemergten PRs in 30 T)

Beschreibung

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?

Contributor Guide

Research-Richtung
Überprüfen Sie zunächst die korrekte Parameterreihenfolge für produce or load, indem Sie den Quellcode im DrWatson.jl Repository (wahrscheinlich in src/) untersuchen. Das aktuelle Dokumentationsbeispiel zeigt die Reihenfolge (path, config, function), während die API Signatur (function, config, path) anzeigt. Bestätigen Sie, welche Reihenfolge beabsichtigt ist, und aktualisieren Sie entweder das Beispiel in der Dokumentationsdatei (z. B. docs/src/real world.md) oder die API Dokumentation entsprechend. Wenn das Beispiel korrekt ist, muss möglicherweise der Funktionssignaturkommentar im Quellcode korrigiert werden.
Tech Stack
Keine
Domain
documentation
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Unter 1 Stunde
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Wartet auf Maintainer Antwort
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Recherche nötig
Voraussetzungen
basic DrWatson package usage
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
70