JuliaLang/julia

Undocumented exceptions

Open

#24043 opened on Oct 7, 2017

View on GitHub
 (18 comments) (0 reactions) (0 assignees)Julia (48,709 stars) (5,773 forks)batch import
Hacktoberfestdocsgood first issuehelp wanted

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.

Contributor guide

Tech stack
None
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
Familiarity with Julia exception types
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
50
Research direction
Add docstrings for each listed exception in their respective source files (e.g., base/deprecated.jl, base/linAlg.jl, etc.). Refer to existing documented exceptions for style conventions. The maintainers have not provided specific guidance; a PR with concise descriptions would be welcome.