JuliaLang/julia

Better documentation for `methods`

Open

#34.761 aperta il 14 feb 2020

Vedi su GitHub
 (11 commenti) (0 reazioni) (0 assegnatari)Julia (5773 fork)batch import
docsgood first issue

Metriche repository

Star
 (48.709 star)
Metriche merge PR
 (Merge medio 20g 6h) (157 PR mergiate in 30 g)

Descrizione

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.

Guida contributor

Direzione di ricerca
Esamina la documentazione corrente per la funzione `methods` nella libreria standard di Julia e individua le aree in cui il comportamento relativo alla raccolta e al matching dei metodi è spiegato in modo insufficiente.
Tech stack
Nessuno
Dominio
documentation
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Mezza giornata
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Abbastanza chiara
Prerequisiti
Julia
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
65