haskell-docs: A program to find and display the docs and type of a name

[ bsd3, development, library, program ] [ Propose Tags ]

Given a module name and a name, or just a name, it will find and display the documentation of that name.


$ haskell-docs hSetBuffering
Package: base
Module: GHC.IO.Handle
hSetBuffering :: Handle -> BufferMode -> IO ()
Computation hSetBuffering `hdl mode` sets the mode of buffering for
 handle `hdl` on subsequent reads and writes.


You should ensure that you have

documentation: True

in your .cabal/config so that the necessary .haddock files are generated.

Haddock is very sensitive to the GHC version. This program tries not to be. If you cannot install this package due to a version problem, open a Github issue. If the versions match up but the build fails, open a Github issue. Neither case should arise.


> :def doc \input -> return (":!haskell-docs " ++ input)
> :doc getContents
The getContents operation returns all user input as a single string,
 which is read lazily as it is needed
 (same as hGetContents stdin).

Add the above :def to your user .ghci to have it on start-up.


Issues/ideas/contributions please make a Github issue: http://github.com/ivan-m/haskell-docs/issues


Maintainer's Corner

Package maintainers

For package maintainers and hackage trustees


Versions [RSS],,, 3.0.0, 3.0.2, 3.0.3, 4.0.0, 4.1.0, 4.1.1, 4.1.2, 4.1.3, 4.1.4, 4.1.5, 4.2.0, 4.2.1, 4.2.2, 4.2.3, 4.2.4, 4.2.5, 4.2.6, 4.2.7, 4.2.8, 4.2.9
Dependencies aeson, base (>4 && <5), base16-bytestring, bytestring, Cabal, containers, cryptohash, cryptonite (<0.22), directory, filepath, ghc (>=7.4 && <8.7), ghc-paths, haddock (>=2.11 && <2.12 || >=2.13 && <2.15), haddock-api, haddock-library, haskell-docs, monad-loops, process, text, unordered-containers [details]
License BSD-3-Clause
Copyright 2012 Chris Done
Author Chris Done
Maintainer Ivan.Miljenovic@gmail.com
Category Development
Home page http://github.com/ivan-m/haskell-docs
Bug tracker http://github.com/ivan-m/haskell-docs/issues
Source repo head: git clone git://github.com/ivan-m/haskell-docs.git
Uploaded by IvanMiljenovic at 2019-05-15T11:33:02Z
Reverse Dependencies 1 direct, 0 indirect [details]
Executables haskell-docs
Downloads 21543 total (49 in the last 30 days)
Rating (no votes yet) [estimated by Bayesian average]
Your Rating
  • λ
  • λ
  • λ
Status Docs available [build log]
Last success reported on 2019-05-15 [all 1 reports]