Cleaned a little bit of docs

src/IHaskell/BrokenPackages.hs

@@ -19,6 +19,9 @@ data BrokenPackage = BrokenPackage {
 instance Show BrokenPackage where
   show = packageID
 
+-- | Get a list of broken packages.
+-- This function internally shells out to `ghc-pkg`, and parses the output
+-- in order to determine what packages are broken.
 getBrokenPackages :: IO [String]
 getBrokenPackages = shelly $ do
   silently $ errExit False $ run "ghc-pkg" ["check"]

src/IHaskell/Display.hs

 {-# LANGUAGE NoImplicitPrelude, OverloadedStrings, FlexibleInstances #-}
+
+-- | If you are interested in the IHaskell library for the purpose of
+-- augmenting the IHaskell notebook or writing your own display mechanisms
+-- and widgets, this module contains all functions you need. 
+--
+-- In order to create a display mechanism for a particular data type, write
+-- a module named (for example) @IHaskell.Display.YourThing@ in a package named @ihaskell-yourThing@.
+-- (Note the capitalization - it's important!) Then, in that module, add an
+-- instance of @IHaskellDisplay@ for your data type. Similarly, to create
+-- a widget, add an instance of @IHaskellWidget@. 
+--
+-- An example of creating a display is provided in the <http://gibiansky.github.io/IHaskell/demo.html demo notebook>.
+--
 module IHaskell.Display (
+  -- * Rich display and interactive display typeclasses and types
   IHaskellDisplay(..),
+  Display(..),
+  DisplayData(..),
   IHaskellWidget(..),
+
+  -- ** Interactive use functions
+  printDisplay,
+
+  -- * Constructors for displays
   plain, html, png, jpg, svg, latex, javascript, many,
-  serializeDisplay,
+
+  -- ** Image and data encoding functions
   Width, Height, Base64(..),
   encode64, base64,
-  Display(..),
-  DisplayData(..),
-  printDisplay,
+
+  -- ** Utilities
   switchToTmpDir,
 
-  -- Internal only use
+  -- * Internal only use
   displayFromChan,
+  serializeDisplay,
   Widget(..),
   ) where
 
@@ -26,7 +48,6 @@ import Data.Aeson (Value)
 
 import System.Directory(getTemporaryDirectory, setCurrentDirectory)
 
-
 import Control.Concurrent.STM.TChan
 import System.IO.Unsafe (unsafePerformIO)
 

src/IHaskell/Eval/Completion.hs

 {-# LANGUAGE NoImplicitPrelude, OverloadedStrings, DoAndIfThenElse #-}
 {- |
-Description : Generates tab completion options.
+Description:    Generates tab completion options.
 
 This has a limited amount of context sensitivity. It distinguishes between four contexts at the moment:
 - import statements (completed using modules)