JuliaDynamics/DrWatson.jl

The examples in the document are inconsistent with the API interface

Open

#410 ouverte le 9 avr. 2024

Voir sur GitHub
 (1 commentaire) (0 réactions) (0 assignés)Julia (94 forks)batch import
documentationgood first issue

Métriques du dépôt

Stars
 (915 stars)
Métriques de merge PR
 (Aucune PR mergée en 30 j)

Description

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?

Guide contributeur

Direction de recherche
Tout d'abord, vérifiez l'ordre correct des paramètres pour produce or load en examinant son code source dans le dépôt DrWatson.jl (probablement dans src/). L'exemple actuel de la documentation montre l'ordre (path, config, function) tandis que la signature de l'API montre (function, config, path). Confirmez quel ordre est prévu et mettez à jour soit l'exemple dans le fichier de documentation (par exemple docs/src/real world.md), soit la documentation de l'API en conséquence. Si l'exemple est correct, le commentaire de signature de fonction dans le code source peut nécessiter une correction.
Stack technique
Aucun
Domaine
documentation
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Moins d'une heure
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
En attente d'un mainteneur
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Investigation requise
Prérequis
basic DrWatson package usage
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
70