Fix documentation for setByteArray#
authorBen Gamari <ben@smart-cactus.org>
Wed, 8 Feb 2017 23:55:32 +0000 (18:55 -0500)
committerBen Gamari <ben@smart-cactus.org>
Thu, 9 Feb 2017 02:25:24 +0000 (21:25 -0500)
The documentation was previously unusably incomplete.

compiler/prelude/primops.txt.pp

index 533d198..f1ee3b3 100644 (file)
@@ -1440,7 +1440,8 @@ primop  CopyAddrToByteArrayOp "copyAddrToByteArray#" GenPrimOp
 
 primop  SetByteArrayOp "setByteArray#" GenPrimOp
   MutableByteArray# s -> Int# -> Int# -> Int# -> State# s -> State# s
-  {Set the range of the MutableByteArray# to the specified character.}
+  {{\tt setByteArray# ba off len c} sets the byte range {\tt [off, off+len]} of
+   the {\tt MutableByteArray#} to the byte {\tt c}.}
   with
   has_side_effects = True
   code_size = { primOpCodeSizeForeignCall + 4 }