JuliaLang/julia

Undocumented exceptions

Open

#24.043 aperta il 7 ott 2017

Vedi su GitHub
 (18 commenti) (0 reazioni) (0 assegnatari)Julia (5773 fork)batch import
Hacktoberfestdocsgood first issuehelp wanted

Metriche repository

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

Descrizione

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.

Guida contributor

Direzione di ricerca
Trova i file sorgente per ogni eccezione elencata (ad esempio, il file linalg per PosDefException) e aggiungi docstring inline che descrivano quando viene lanciata l'eccezione e le cause tipiche.
Tech stack
julia
Dominio
Nessuno
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Julia
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
70