Commit aa2143e0 authored by Moritz Angermann's avatar Moritz Angermann Committed by Ben Gamari
Browse files

Improve documentation for CreateBCOs Message.

After falling over the CreateBCOs message, and expecting it to contain
ByteStrings encoding `ResolvedBCO`s instead of `[ResolvedBCO]`s, when
deubbing issues with iserv, I'd like to extend the documentation here
a bit, so the next one won't fall over it.

Reviewers: simonmar, austin, rwbarton, bgamari

Reviewed By: bgamari

Subscribers: thomie

Differential Revision: https://phabricator.haskell.org/D3234
parent 23aca132
......@@ -85,6 +85,9 @@ data Message a where
-- Interpreter -------------------------------------------
-- | Create a set of BCO objects, and return HValueRefs to them
-- Note: Each ByteString contains a Binary-encoded [ResolvedBCO], not
-- a ResolvedBCO. The list is to allow us to serialise the ResolvedBCOs
-- in parallel. See @createBCOs@ in compiler/ghci/GHCi.hsc.
CreateBCOs :: [LB.ByteString] -> Message [HValueRef]
-- | Release 'HValueRef's
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment