From 4e7e3f94565a5423aca0660ee822308d16a7f722 Mon Sep 17 00:00:00 2001 From: Pepe Iborra Date: Tue, 22 Dec 2020 09:15:57 +0000 Subject: [PATCH] Add Haddock markup to SystemInterface --- src/ShellCheck/Interface.hs | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/src/ShellCheck/Interface.hs b/src/ShellCheck/Interface.hs index 85d25c0..87346a1 100644 --- a/src/ShellCheck/Interface.hs +++ b/src/ShellCheck/Interface.hs @@ -73,15 +73,15 @@ import qualified Data.Map as Map data SystemInterface m = SystemInterface { - -- Read a file by filename, or return an error + -- | Read a file by filename, or return an error siReadFile :: String -> m (Either ErrorMessage String), - -- Given: + -- | Given: -- the current script, -- a list of source-path annotations in effect, -- and a sourced file, -- find the sourced file siFindSource :: String -> [String] -> String -> m FilePath, - -- Get the configuration file (name, contents) for a filename + -- | Get the configuration file (name, contents) for a filename siGetConfig :: String -> m (Maybe (FilePath, String)) }