haskell-docs: A program to find and display the docs of a name from a given module.

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

EXAMPLE USAGE

$ haskell-docs Data.List.Split split
Split a list according to the given splitting strategy. This is
 how to "run" a Splitter that has been built using the other
 combinators.

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, and so too will this program be, to GHC, and to Haddock. I suggest installing like this:

cabal install haskell-docs --constraint haddock==2.10.0

But replace the 2.10.0 with the version that haddock --version gives you.

I could perhaps instead have a flag for each GHC release back a few versions.

USING WITH GHCI

> :def doc \input -> return (":!haskell-docs " ++ input)
> :doc System.IO getContents base
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

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

Downloads

• haskell-docs-0.1.1.0.tar.gz [browse] (Cabal source package)
• Package description (as included in the package)

Maintainer's Corner

Package maintainers

• AnthonyCowley, ChrisDone, IvanMiljenovic

For package maintainers and hackage trustees

• edit package information

Candidates

• 3.0.2