Consolidate comment, undo whitespace changes

Author: jhrcek

plugins/hls-rename-plugin/src/Ide/Plugin/Rename.hs

@@ -101,6 +101,7 @@ renameProvider state pluginId (RenameParams _prog (TextDocumentIdentifier uri) p
         [] -> throwError $ PluginInvalidParams "No symbol to rename at given position"
         _  -> do
             refs <- HS.fromList . concat <$> mapM (refsAtName state nfp) oldNames
+
             -- Validate rename
             crossModuleEnabled <- liftIO $ runAction "rename: config" state $ usePropertyAction #crossModule pluginId properties
             unless crossModuleEnabled $ failWhenImportOrExport state nfp refs oldNames
@@ -196,10 +197,7 @@ refsAtName state nfp name = do
     dbRefs <- case nameModule_maybe name of
         Nothing -> pure []
         Just mod -> liftIO $ mapMaybe rowToLoc <$> withHieDb (\hieDb ->
-            -- GHC inserts `Use`s of record constructor everywhere where its record selectors are used,
-            -- which leads to fields being renamed whenever corresponding constructor is renamed.
-            -- see https://github.com/haskell/haskell-language-server/issues/2915
-            -- To work around this, we filter out compiler-generated references.
+            -- See Note [Generated references]
             filter (\(refRow HieDb.:. _) -> refIsGenerated refRow) <$>
             findReferences
                 hieDb
@@ -235,8 +233,13 @@ handleGetHieAst state nfp =
     -- which is bad (see https://github.com/haskell/haskell-language-server/issues/3799)
     fmap removeGenerated $ runActionE "Rename.GetHieAst" state $ useE GetHieAst nfp
 
--- | We don't want to rename in code generated by GHC as this gives false positives.
--- So we restrict the HIE file to remove all the generated code.
+{- Note [Generated references]
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+GHC inserts `Use`s of record constructor everywhere where its record selectors are used,
+which leads to record fields being renamed whenever corresponding constructor is renamed.
+see https://github.com/haskell/haskell-language-server/issues/2915
+To work around this, we filter out compiler-generated references.
+-}
 removeGenerated :: HieAstResult -> HieAstResult
 removeGenerated HAR{..} =
     HAR{hieAst = sourceOnlyAsts, refMap = sourceOnlyRefMap, ..}