JuliaLang/julia

Undocumented exceptions

Open

#24.043 geöffnet am 7. Okt. 2017

Auf GitHub ansehen
 (18 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Julia (5.773 Forks)batch import
Hacktoberfestdocsgood first issuehelp wanted

Repository-Metriken

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

Beschreibung

Some days ago I generated a list of Exceptions without inline documentation. Here it is:

 Base.DNSError
 Base.Distributed.BatchProcessingError
 Base.LibGit2.Error.GitError
 Base.LinAlg.ARPACKException
 Base.LinAlg.LAPACKException
 Base.LinAlg.PosDefException
 Base.LinAlg.RankDeficientException
 Base.LinAlg.SingularException
 Base.Pkg.Entry.PkgTestError
 Base.Pkg.PkgError
 Base.Pkg.Resolve.MaxSum.UnsatError
 Base.PrecompilableError
 Base.SimdLoop.SimdError
 Base.SparseArrays.CHOLMOD.CHOLMODException
 Base.SparseArrays.UMFPACK.MatrixIllConditionedException
 Base.Test.FallbackTestSetException
 Base.UVError                                                          
 ~Base.WrappedException~   
 InvalidStateException
 SegmentationFault
 UnicodeError

Some of those are quite prominent, e.g. PosDefException.

Contributor Guide

Research-Richtung
Finde die Quelldateien für jede aufgeführte Ausnahme (z.B. die linalg Datei für PosDefException) und füge Inline Docstrings hinzu, die beschreiben, wann die Ausnahme ausgelöst wird und typische Ursachen.
Tech Stack
julia
Domain
Keine
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.
1-3 Stunden
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.
Klar
Voraussetzungen
Julia
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
70