Skip to content

Commit

Permalink
Reformat haddocks according to manual, unfortunately this doesn't app…
Browse files Browse the repository at this point in the history
…ear to get formatted correctly on hackage :/
  • Loading branch information
cdepillabout committed Nov 13, 2018
1 parent fc89918 commit 77cb108
Show file tree
Hide file tree
Showing 2 changed files with 54 additions and 54 deletions.
56 changes: 28 additions & 28 deletions src/Termonad/App.hs
Original file line number Diff line number Diff line change
Expand Up @@ -417,51 +417,51 @@ start tmConfig = do
--
-- - @~\/.config\/termonad\/termonad.hs@ exists, @~\/.cache\/termonad\/termonad-linux-x86_64@ exists
--
-- The timestamps of these two files are checked. If the
-- @~\/.config\/termonad\/termonad.hs@ file has been modified after the
-- @~\/.cache\/termonad\/termonad-linux-x86_64@ binary, then Termonad will use
-- GHC to recompile the @~\/.config\/termonad\/termonad.hs@ file, producing a
-- new binary at @~\/.cache\/termonad\/termonad-linux-x86_64@. This new binary
-- will be re-executed. The 'TMConfig' passed to this 'defaultMain' will be
-- effectively thrown away.
-- The timestamps of these two files are checked. If the
-- @~\/.config\/termonad\/termonad.hs@ file has been modified after the
-- @~\/.cache\/termonad\/termonad-linux-x86_64@ binary, then Termonad will use
-- GHC to recompile the @~\/.config\/termonad\/termonad.hs@ file, producing a
-- new binary at @~\/.cache\/termonad\/termonad-linux-x86_64@. This new binary
-- will be re-executed. The 'TMConfig' passed to this 'defaultMain' will be
-- effectively thrown away.
--
-- If GHC fails to recompile the @~\/.config\/termonad\/termonad.hs@ file, then
-- Termonad will just execute 'start' with the 'TMConfig' passed in.
-- If GHC fails to recompile the @~\/.config\/termonad\/termonad.hs@ file, then
-- Termonad will just execute 'start' with the 'TMConfig' passed in.
--
-- If the @~\/.cache\/termonad\/termonad-linux-x86_64@ binary has been modified
-- after the @~\/.config\/termonad\/termonad.hs@ file, then Termonad will
-- re-exec the @~\/.cache\/termonad\/termonad-linux-x86_64@ binary. The
-- 'TMConfig' passed to this 'defaultMain' will be effectively thrown away.
-- If the @~\/.cache\/termonad\/termonad-linux-x86_64@ binary has been modified
-- after the @~\/.config\/termonad\/termonad.hs@ file, then Termonad will
-- re-exec the @~\/.cache\/termonad\/termonad-linux-x86_64@ binary. The
-- 'TMConfig' passed to this 'defaultMain' will be effectively thrown away.
--
-- - @~\/.config\/termonad\/termonad.hs@ exists, @~\/.cache\/termonad\/termonad-linux-x86_64@ does not exist
--
-- Termonad will use GHC to recompile the @~\/.config\/termonad\/termonad.hs@
-- file, producing a new binary at @~\/.cache\/termonad\/termonad-linux-x86_64@.
-- This new binary will be re-executed. The 'TMConfig' passed to this
-- 'defaultMain' will be effectively thrown away.
-- Termonad will use GHC to recompile the @~\/.config\/termonad\/termonad.hs@
-- file, producing a new binary at @~\/.cache\/termonad\/termonad-linux-x86_64@.
-- This new binary will be re-executed. The 'TMConfig' passed to this
-- 'defaultMain' will be effectively thrown away.
--
-- If GHC fails to recompile the @~/.config/termonad/termonad.hs@ file, then
-- Termonad will just execute 'start' with the 'TMConfig' passed in.
-- If GHC fails to recompile the @~\/.config\/termonad\/termonad.hs@ file, then
-- Termonad will just execute 'start' with the 'TMConfig' passed in.
--
-- - @~/.config/termonad/termonad.hs@ does not exist, @~/.cache/termonad/termonad-linux-x86_64@ exists
-- - @~\/.config\/termonad\/termonad.hs@ does not exist, @~\/.cache\/termonad\/termonad-linux-x86_64@ exists
--
-- Termonad will ignore the @~/.cache/termonad/termonad-linux-x86_64@ binary
-- and just run 'start' with the 'TMConfig' passed to this function.
-- Termonad will ignore the @~\/.cache\/termonad\/termonad-linux-x86_64@ binary
-- and just run 'start' with the 'TMConfig' passed to this function.
--
-- - @~/.config/termonad/termonad.hs@ does not exist, @~/.cache/termonad/termonad-linux-x86_64@ does not exist
-- - @~\/.config\/termonad\/termonad.hs@ does not exist, @~\/.cache\/termonad\/termonad-linux-x86_64@ does not exist
--
-- Termonad will run 'start' with the 'TMConfig' passed to this function.
-- Termonad will run 'start' with the 'TMConfig' passed to this function.
--
-- Other notes:
--
-- 1. That the locations of @~/.config/termonad/termonad.hs@ and
-- @~/.cache/termonad/termonad-linux-x86_64@ may differ depending on your
-- 1. That the locations of @~\/.config\/termonad\/termonad.hs@ and
-- @~\/.cache\/termonad\/termonad-linux-x86_64@ may differ depending on your
-- system.
--
-- 2. In your own @~/.config/termonad/termonad.hs@ file, you can use either
-- 2. In your own @~\/.config\/termonad\/termonad.hs@ file, you can use either
-- 'defaultMain' or 'start'. As long as you always execute the system-wide
-- @termonad@ binary (instead of the binary produced as
-- @~/.cache/termonad/termonad-linux-x86_64@), the effect should be the same.
-- @~\/.cache\/termonad\/termonad-linux-x86_64@), the effect should be the same.
defaultMain :: TMConfig -> IO ()
defaultMain tmConfig = do
let params =
Expand Down
52 changes: 26 additions & 26 deletions src/Termonad/Config/Colour.hs
Original file line number Diff line number Diff line change
Expand Up @@ -347,42 +347,42 @@ defaultGreyscale = genVec_ $ \n ->
--
-- * 'cursorFgColour' is 'Set' and 'cursorBgColour' is 'Set'
--
-- The foreground and background colors of the cursor are as you have set.
-- The foreground and background colors of the cursor are as you have set.
--
-- * 'cursorFgColour' is 'Set' and 'cursorBgColour' is 'Unset'
--
-- The cursor background color turns completely black so that it is not
-- visible. The foreground color of the cursor is the color that you have
-- 'Set'. This ends up being mostly unusable, so you are recommended to
-- always 'Set' 'cursorBgColour' when you have 'Set' 'cursorFgColour'.
-- The cursor background color turns completely black so that it is not
-- visible. The foreground color of the cursor is the color that you have
-- 'Set'. This ends up being mostly unusable, so you are recommended to
-- always 'Set' 'cursorBgColour' when you have 'Set' 'cursorFgColour'.
--
-- * 'cursorFgColour' is 'Unset' and 'cursorBgColour' is 'Set'
--
-- The cursor background color becomes the color you 'Set', while the cursor
-- foreground color doesn't change from the letter it is over. For instance,
-- imagine there is a letter on the screen with a black background and a
-- green foreground. If you bring the cursor overtop of it, the cursor
-- background will be the color you have 'Set', while the cursor foreground
-- will be green.
--
-- This is completely usable, but is slightly annoying if you place the cursor
-- over a letter with the same foreground color as the cursor's background
-- color, because the letter will not be readable. For instance, imagine you
-- have set your cursor background color to red, and somewhere on the screen
-- there is a letter with a black background and a red foreground. If you move
-- your cursor over the letter, the background of the cursor will be red (as
-- you have set), and the cursor foreground will be red (to match the original
-- foreground color of the letter). This will make it so you can't
-- actually read the letter, because the foreground and background are both
-- red.
-- The cursor background color becomes the color you 'Set', while the cursor
-- foreground color doesn't change from the letter it is over. For instance,
-- imagine there is a letter on the screen with a black background and a
-- green foreground. If you bring the cursor overtop of it, the cursor
-- background will be the color you have 'Set', while the cursor foreground
-- will be green.
--
-- This is completely usable, but is slightly annoying if you place the cursor
-- over a letter with the same foreground color as the cursor's background
-- color, because the letter will not be readable. For instance, imagine you
-- have set your cursor background color to red, and somewhere on the screen
-- there is a letter with a black background and a red foreground. If you move
-- your cursor over the letter, the background of the cursor will be red (as
-- you have set), and the cursor foreground will be red (to match the original
-- foreground color of the letter). This will make it so you can't
-- actually read the letter, because the foreground and background are both
-- red.
--
-- * 'cursorFgColour' is 'Unset' and 'cursorBgColour' is 'Unset'
--
-- This combination makes the cursor inverse of whatever text it is over.
-- If your cursor is over red text with a black background, the cursor
-- background will be red and the cursor foreground will be black.
-- This combination makes the cursor inverse of whatever text it is over.
-- If your cursor is over red text with a black background, the cursor
-- background will be red and the cursor foreground will be black.
--
-- This is the default.
-- This is the default.
--
-- See 'defaultColourConfig' for the defaults for 'ColourConfig' used in Termonad.
data ColourConfig c = ColourConfig
Expand Down

0 comments on commit 77cb108

Please sign in to comment.