JuliaLang/julia

Better documentation for `methods`

Open

#34 761 ouverte le 14 févr. 2020

Voir sur GitHub
 (11 commentaires) (0 réactions) (0 assignés)Julia (5 773 forks)batch import
docsgood first issue

Métriques du dépôt

Stars
 (48 709 stars)
Métriques de merge PR
 (Merge moyen 20j 6h) (157 PRs mergées en 30 j)

Description

I believe methods should have a bit more of information, consider,

struct A end
methods(A)
struct B{T} end
methods(B)
methods(B{Int})
struct C{T}
    C(x) = new{Int}(0)
end
methods(C)

Basically the way that methods are collected / match isn’t well documented.

Guide contributeur

Direction de recherche
Examinez la documentation actuelle de la fonction `methods` dans la bibliothèque standard de Julia et identifiez les domaines où le comportement concernant la collecte et la correspondance des méthodes est insuffisamment expliqué.
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.
Une demi journée
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Plutôt claire
Prérequis
Julia
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
65