Add some comments

Author: sgillespie

plugins/hls-change-type-signature-plugin/src/Ide/Plugin/ChangeTypeSignature.hs

@@ -135,6 +135,7 @@ diagnosticToChangeSig
     -> FileDiagnostic
     -> HandlerM Config (Maybe ChangeSignature)
 diagnosticToChangeSig recorder decls diagnostic = runMaybeT $ do
+    -- Extract expected, actual, and extra error info
     (expectedType, actualType, errInfo) <- hoistMaybe $ do
         msg <- diagnostic ^. fdStructuredMessageL ^? _SomeStructuredMessage
         tcRnMsg <- msg ^. msgEnvelopeErrorL ^? _TcRnMessage
@@ -146,15 +147,17 @@ diagnosticToChangeSig recorder decls diagnostic = runMaybeT $ do
 
         pure (showType expectedType, showType actualType, errInfo)
 
-    logWith recorder Development.IDE.Warning (LogErrInfoCtxt errInfo)
+    logWith recorder Debug (LogErrInfoCtxt errInfo)
 
+    -- Extract the declName from the extra error text
     declName <- hoistMaybe (matchingDiagnostic errInfo)
 
+    -- Look up location of declName. If it fails, log it
     declSrcSpan <-
         case findSigLocOfStringDecl decls expectedType (T.unpack declName) of
             Just x -> pure x
             Nothing -> do
-                logWith recorder Development.IDE.Warning (LogFindSigLocFailure declName)
+                logWith recorder Debug (LogFindSigLocFailure declName)
                 hoistMaybe Nothing
 
     pure ChangeSignature{..}