The haskell-docs package

[Tags: bsd3, library, program]

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

EXAMPLE USAGE

 $ 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.

INSTALLATION

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.

USING WITH GHCI

 > :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.

CONTRIBUTION AND ISSUES

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


Properties

Versions0.1.0.0, 0.1.1.0, 0.2.0.0, 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
Dependenciesaeson, base (>4 && <5), bytestring, Cabal, containers, directory, filepath, ghc (>=7.2 && <7.9), ghc-paths, haskell-docs, monad-loops, text, unordered-containers
LicenseBSD3
Copyright2012 Chris Done
AuthorChris Done
Maintainerchrisdone@gmail.com
CategoryDevelopment
Home pagehttp://github.com/chrisdone/haskell-docs
Bug trackerhttp://github.com/chrisdone/haskell-docs/issues
Source repositoryhead: git clone git://github.com/chrisdone/haskell-docs.git
Executableshaskell-docs
Upload dateThu Jul 3 15:36:55 UTC 2014
Uploaded byChrisDone
Downloads2415 total (437 in last 30 days)

Modules

[Index]

Downloads

Maintainers' corner

For package maintainers and hackage trustees