Help

Import this module in the repl to access docstrings. When defining docstrings it is best to import only Help.Docstring.

Documentation

help :: Name -> IO ()

Retrieve documentation for a value/function identifier `myIdentifier or a type identifier `'MyIdentifier.

help will find documentation from any use of docstring in previously imported modules. Documentation for a module MyModule is conventionally found in an associated Docs|]

docstring :: Name -> String -> Q [Dec]

Add documentation string for given Name, to be retrieved by help. You may want to use the str quasiquoter for convinient multiline documentation. (See definition for docstring)

docstring adds documentation to a magic global scope as a Template Haskell side effect and so documentation for MyModule should probably be added only in a seperate Doc module to avoid polluting application code