Fix typo in 8.8.1 notes related to traceBinaryEvent
authoriustin <iustin@k1024.org>
Fri, 26 Apr 2019 13:07:33 +0000 (09:07 -0400)
committerBen Gamari <ben@smart-cactus.org>
Sat, 15 Jun 2019 18:47:50 +0000 (14:47 -0400)
- fixes double mention of `traceBinaryEvent#` (the second one should be `traceEvent#`, I think)
- fixes note about `traceEvent#` taking a `String` - the docs say it takes a zero-terminated ByteString.

(cherry picked from commit 63150b9e5583c5fc3252f242981b0d26f11348b2)

docs/users_guide/8.8.1-notes.rst

index 5e96547..9d1466c 100644 (file)
@@ -178,8 +178,9 @@ Template Haskell
 ~~~~~~~~~~~~~~~~~~~~
 
 - GHC now exposes a new primop, ``traceBinaryEvent#``. This primop writes
-  eventlog events similar to ``traceBinaryEvent#`` but allows the user to pass
-  the event payload as a binary blob instead of a ``String``.
+  eventlog events similar to ``traceEvent#`` but allows the user to pass
+  the event payload as a binary blob instead of a zero-terminated
+  ``ByteString``.
 
 - The ``StableName#`` type parameter now has a phantom role instead of
   a representational one. There is really no reason to care about the