documentation - Where can I find the docs for Haskell's GHC.* modules? -
i'm trying understand how haskell package chesshs implemented. chess board represented ghc.arr.array
, found out in ghci:
prelude chess> :i board data board = board {turn :: color, castlingavail :: string, enpassant :: maybe (int, int), board :: ghc.arr.array (int, int) (maybe piece)} -- defined in ‘chess’ instance eq board -- defined in ‘chess’ instance show board -- defined in ‘chess’ prelude chess>
by googling found out ghc.arr
module part of "base" package. found documentation of package on https://hackage.haskell.org/package/base
however, on page many hyperlinks various ghc.* modules not clickable. why not? can find documentation of these modules? in general, what's best way access arbitrary module's documentation?
(i tried searching hoogle "ghc.arr" , "ghc.arr.array", didn't return relevant)
functions ghc.*
modules should in cases not used directly. reexported more user-friendly packages or modules. in example, documentation arrays can found in array
package.
if not help, can directly @ source, contain documentation comments too. source code of ghc , base library mirrored github, source ghc.arr
here.
the source code shows why ghc.arr
module not clickable in base package documentation: line 3 of ghc/arr.hs contains following pragma:
{-# options_haddock hide #-}
so module intentionally hidden, since it's internal module not meant general usage.
Comments
Post a Comment