JuliaLang/julia

Undocumented exceptions

Open

#24 043 ouverte le 7 oct. 2017

Voir sur GitHub
 (18 commentaires) (0 réactions) (0 assignés)Julia (5 773 forks)batch import
Hacktoberfestdocsgood first issuehelp wanted

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

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.

Guide contributeur

Direction de recherche
Trouvez les fichiers source pour chaque exception listée (par exemple, le fichier linalg pour PosDefException) et ajoutez des docstrings en ligne décrivant quand l'exception est levée et les causes typiques.
Stack technique
julia
Domaine
Aucun
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.
1-3 heures
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.
Claire
Prérequis
Julia
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
70