Add comments, remove unnecessary imports

Author: HirotoShioi

src/Classify.hs

@@ -11,7 +11,6 @@ import           Universum
 import qualified Codec.Archive.Zip as Zip
 import qualified Data.ByteString.Lazy.Char8 as LBSC
 import qualified Data.List.NonEmpty as N
-import           Data.Map.Strict (Map)
 import qualified Data.Map.Strict as Map
 import           GHC.Stack (HasCallStack)
 import           Regex (MatchWithCaptures, Regex, RegexCompileError, RegexString, compileRegex,

src/LogAnalysis/Classifier.hs

@@ -53,7 +53,7 @@ filterAnalysis as = do
 extractErrorCodes :: Analysis -> [ Text ]
 extractErrorCodes as = map (\(Knowledge{..}, _) -> renderErrorCode kErrorCode) $ Map.toList as
 
--- | TODO: Format the text in better way
+-- | TODO (Hiroto): Format the text in better way
 prettyFormatAnalysis :: Analysis -> LText
 prettyFormatAnalysis as =
     let aList = Map.toList as

src/LogAnalysis/KnowledgeCSVParser.hs

@@ -11,7 +11,7 @@ import qualified Data.Text.Lazy as LT
 
 import           LogAnalysis.Types (ErrorCode (..), Knowledge (..))
 
--- |Take any string that is inside quotes
+-- | Take any string that is inside quotes
 insideQuotes :: Parser LText
 insideQuotes =
     LT.append <$> (LT.fromStrict <$> ALT.takeWhile (/= '"'))
@@ -46,7 +46,7 @@ parseErrorCode =
     <|> (string "Unknown"           >> return Unknown)
     <|> (string "Error"             >> return Error)
 
--- |Parse each csv records
+-- | Parse each csv records
 parseKnowledge :: Parser Knowledge -- not really clean code..
 parseKnowledge = do
     e <- quotedField
@@ -60,6 +60,6 @@ parseKnowledge = do
     s <- quotedField
     return $ Knowledge e c p s
 
--- |Parse CSV file and create knowledgebase
+-- | Parse CSV file and create knowledgebase
 parseKnowLedgeBase :: Parser [ Knowledge ]
 parseKnowLedgeBase = many $ parseKnowledge <* endOfLine

src/LogAnalysis/Types.hs

@@ -11,7 +11,6 @@ module LogAnalysis.Types
 
 import           Universum
 
-import           Data.Map.Strict (Map)
 import qualified Data.Map.Strict as Map
 
 -- | Identifier for each error
@@ -35,10 +34,10 @@ data ErrorCode
 
 -- | Record identifying the issue
 data Knowledge = Knowledge
-  {  kErrorText :: !LText   -- ^ Text used for matching error lines
+  {  kErrorText :: !LText   　-- ^ Text used for matching error lines
   ,  kErrorCode :: !ErrorCode -- ^ Identity for error code
-  ,  kProblem   :: !LText   -- ^ Text describing what is the problem
-  ,  kSolution  :: !LText   -- ^ Text describing how to solve the issue
+  ,  kProblem   :: !LText   　-- ^ Text describing what is the problem
+  ,  kSolution  :: !LText   　-- ^ Text describing how to solve the issue
   } deriving (Show)
 
 renderErrorCode :: ErrorCode -> Text

src/Regex.hs

@@ -15,7 +15,6 @@ module Regex
 import           Universum
 
 import qualified Data.Array as Array
-import           Data.Map.Strict (Map)
 import qualified Data.Map.Strict as Map
 import qualified Text.Regex.TDFA as TDFA
 import           Text.Regex.TDFA.ByteString.Lazy (Regex)

src/Util.hs

@@ -6,7 +6,6 @@ module Util
 import           Universum
 
 import qualified Codec.Archive.Zip as Zip
-import           Data.Map.Strict (Map)
 import qualified Data.Map.Strict as Map
 
 -- | Extract log file from given zip file

src/Zendesk.hs

@@ -63,9 +63,11 @@ defaultConfig = Config 0 "https://iohk.zendesk.com" "" "daedalus-bug-reports@ioh
 knowledgebasePath :: FilePath
 knowledgebasePath = "./knowledgebase/knowledge.csv"
 
+-- | Filepath to token file
 tokenPath :: FilePath
 tokenPath = "./tmp-secrets/token"
 
+-- | Filepath to assign_to file
 assignToPath :: FilePath
 assignToPath = "./tmp-secrets/assign_to"