Clarify status of bindings in WholeCoreBindingswip/docs-core-prog

Gergo points out that these bindings are tidied, rather than prepd as
the variable claims. Therefore we update the name of the variable to
reflect reality and add a comment to the data type to try to erase any
future confusion.

Fixes #22307

1 files changed, 3 insertions, 3 deletions

diff --git a/compiler/GHC/Unit/Module/WholeCoreBindings.hs b/compiler/GHC/Unit/Module/WholeCoreBindings.hs
index 8e84abbf57..ad29d06246 100644
--- a/compiler/GHC/Unit/Module/WholeCoreBindings.hs
+++ b/compiler/GHC/Unit/Module/WholeCoreBindings.hs
@@ -57,7 +57,7 @@ the object files.
 -}
 
 data WholeCoreBindings = WholeCoreBindings
-            { wcb_bindings :: [IfaceBindingX IfaceMaybeRhs IfaceTopBndrInfo]
-            , wcb_module   :: Module
-            , wcb_mod_location :: ModLocation
+            { wcb_bindings :: [IfaceBindingX IfaceMaybeRhs IfaceTopBndrInfo] -- ^ serialised tidied core bindings.
+            , wcb_module   :: Module  -- ^ The module which the bindings are for
+            , wcb_mod_location :: ModLocation -- ^ The location where the sources reside.
             }