Merge pull request #1021 from bubba/reactorPidCache-documentation

Document reactorPidCache

Author: alanz

hie-plugin-api/Haskell/Ide/Engine/PluginsIdeMonads.hs

@@ -134,6 +134,8 @@ import           Language.Haskell.LSP.VFS       ( VirtualFile(..) )
 -- LSP Commands
 -- ---------------------------------------------------------------------
 
+-- | A monad that provides access to the current process ID.
+-- Used when generating LSP command IDs
 class Monad m => HasPidCache m where
   getPidCache :: m Int
 

src/Haskell/Ide/Engine/LSP/Reactor.hs

@@ -31,7 +31,8 @@ import qualified Language.Haskell.LSP.Types    as J
 data REnv = REnv
   { scheduler         :: Scheduler.Scheduler R
   , lspFuncs          :: Core.LspFuncs Config
-  , reactorPidCache   :: Int -- TODO:AZ: do we need this? what is it for?
+  -- | The process ID of HIE. See 'HasPidCache'
+  , reactorPidCache   :: Int
   , diagnosticSources :: Map.Map DiagnosticTrigger [(PluginId,DiagnosticProviderFunc)]
   , hoverProviders    :: [HoverProvider]
   , symbolProviders   :: [SymbolProvider]