Document exceptions that can be thrown from definitions in `base`
Summary
The haddocks of many definitions in base
such as readFile
do not document which exceptions they throw. Let's change this!
Tracker (WIP)
Tracking which definitions can throw errors across all of base is work in progress, here is a start.
-
System.IO
-
fixIO
-
hReady
-
hPrint
-
openTempFile
-
openBinaryTempFile
-
openTempFileWithDefaultPermissions
-
openBinaryTempFileWithDefaultPermissions
-
interact
-
putChar
-
putStr
-
putStrLn
-
print
-
getChar
*hGetChar
-
getLine
*hGetLine
-
getContents
*hGetContents
-
getContents'
*hGetContents'
-
readFile
! (Note: refers togetContents
but does not make clear it is used in its implementation.) -
readFile'
(Note: refers togetContents'
but does not make clear it is used in its implementation.) -
writeFile
! -
appendFile
! -
readIO
-
readLn
-
GHC.IO.StdHandles
-
stdin
-
stdout
-
stderr
-
openFile
-
openBinaryFile
-
withFile
-
withBinaryFile
-
-
GHC.IO.Handle.Text
-
hWaitForInput
-
hGetChar
-
hGetLine
-
hGetContents
-
hGetContents'
-
hPutChar
-
hPutStr
-
hPutStrLn
*hPutStr
-
hPutBuf
-
hGetBuf
-
hGetBufSome
-
hPutBufNonBlocking
-
hGetBufNonBlocking
-
GHC.IO.Handle
-
hSetFileSize
-
hClose
-
hFileSize
-
hIsEOF
-
isEOF
-
hSetBuffering
-
hGetBuffering
-
hFlush
-
hGetPosn
-
hSetPosn
-
hSeek
-
hTell
-
hIsOpen
-
hIsClosed
-
hIsReadable
-
hIsWritable
-
hIsSeekable
-
hIsTerminalDevice
-
hSetEcho
-
hGetEcho
-
hShow
-
hLookAhead
-
hSetBinaryMode
-
hSetEncoding
-
hGetEncoding
-
hSetNewlineMode
-
-
GHC.IO.Encoding
-
mkTextEncoding
-
-
-
Key
-
no exceptions are documented -
some exceptions are documented -
we are positive that all possible exceptions are documented -
foo
!:foo
is exported inPrelude
-
foo
*bar
:foo
's documentation links tobar
's documentation
Other Libraries
This ticket only tracks documentation improvements for base
, however here I would like to keep track of other platform/boot libraries which could benefit from a similar effort. We will cross-link issues here once issues have been opened for the respective librariers.
bytestring
text
Please feel free to extend this list.