Improve documentation for transform list-comps
authorSimon Peyton Jones <simonpj@microsoft.com>
Fri, 11 Sep 2015 15:23:35 +0000 (16:23 +0100)
committerSimon Peyton Jones <simonpj@microsoft.com>
Fri, 11 Sep 2015 16:03:17 +0000 (17:03 +0100)
Thanks to Jeremy Gibbons for spotting the infelictity

docs/users_guide/glasgow_exts.xml

index 931706b..dbf67c6 100644 (file)
@@ -1887,7 +1887,12 @@ guard        Control.Monad          t1 -&gt; m t2
 fmap         GHC.Base               forall a b. (a-&gt;b) -&gt; n a -&gt; n b
 mzip         Control.Monad.Zip      forall a b. m a -&gt; m b -&gt; m (a,b)
 </programlisting>
-The comprehension should typecheck when its desugaring would typecheck.
+The comprehension should typecheck when its desugaring would typecheck,
+except that (as discussed in <xref linkend=""/>)
+in the "then f" and "then group using f" clauses,
+when the "by b" qualifier is omitted, argument f should have a polymorphic type.
+In particular, "then Data.List.sort" and
+"then group using Data.List.group" are insufficiently polymorphic.
 </para>
 <para>
 Monad comprehensions support rebindable syntax (<xref linkend="rebindable-syntax"/>).