Clarify role of coercion in flattening function
authorRichard Eisenberg <rae@cs.brynmawr.edu>
Thu, 28 Jun 2018 04:08:58 +0000 (00:08 -0400)
committerRichard Eisenberg <rae@cs.brynmawr.edu>
Thu, 28 Jun 2018 04:08:58 +0000 (00:08 -0400)
Comments only: [ci skip]

compiler/typecheck/TcFlatten.hs

index f4176f5..f6a1adf 100644 (file)
@@ -1432,7 +1432,8 @@ flatten_app_tys fun_ty arg_tys
        ; flatten_app_ty_args fun_xi fun_co arg_tys }
 
 -- Given a flattened function (with the coercion produced by flattening) and
--- a bunch of unflattened arguments, flatten the arguments and apply
+-- a bunch of unflattened arguments, flatten the arguments and apply.
+-- The coercion argument's role matches the role stored in the FlatM monad.
 --
 -- The bang patterns used here were observed to improve performance. If you
 -- wish to remove them, be sure to check for regeressions in allocations.