JuliaLang/julia

Better documentation for `methods`

Open

#34.761 geöffnet am 14. Feb. 2020

Auf GitHub ansehen
 (11 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Julia (5.773 Forks)batch import
docsgood first issue

Repository-Metriken

Stars
 (48.709 Stars)
PR-Merge-Metriken
 (Durchschn. Merge 20T 6h) (157 gemergte PRs in 30 T)

Beschreibung

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.

Contributor Guide

Research-Richtung
Untersuche die aktuelle Dokumentation der `methods` Funktion in Julias Standardbibliothek und identifiziere Bereiche, in denen das Verhalten bezüglich Methodensammlung und abgleich unzureichend erklärt wird.
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.
Halber Tag
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Meist klar
Voraussetzungen
Julia
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
65