-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/
-- | Docstrings for documentation in the repl
--
-- This package provides docstring funcionality similar to Python
-- or Lisp. Docstrings are simply strings bound to identifier names. To
-- get access to a name one must enable -XTemplateHaskell and
-- use prime notation like 'myValIdentifier and
-- ''MyTypeIdentifier. Access Docstrings in the repl via
-- help 'myIdentifier, and introduce Docstrings via
-- docstring 'myIdentifier "some documentation" in a module.
@package docstrings
@version 0.1.0.0
module Help.Docstring
-- | 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
docstring :: Name -> String -> Q [Dec]
-- | Import this module in the repl to access docstrings. When defining
-- docstrings it is best to import only Help.Docstring.
module Help
-- | 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|]
help :: Name -> IO ()
-- | 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
docstring :: Name -> String -> Q [Dec]