parallel package: minor error in the documentation of Control.Parallel.Strategies.parMap

[Tsuyoshi Ito]

Hello,

I think that the documentation of the parallel package version 3.1.0.1
contains a minor error (I hope that this is the right place to report
such an issue).  Namely, the documentation of
Control.Parallel.Strategies.parMap (see
http://hackage.haskell.org/packages/archive/parallel/3.1.0.1/doc/html/Control-Parallel-Strategies.html#v:parMap)
contains the following remark:

> parMap strat f = withStrategy strat . map f

but this is incorrect.  Being new to Parallel Haskell, I had been
confused by this remark, wondering why this means that the elements
are evaluated in parallel, until I found out that the actual
implementation was:

> parMap strat f = (`using` parList strat) . map f

or equivalently:

  parMap strat f = withStrategy (parList strat) . map f

Please fix the documentation.  Thank you in advance.

Best regards,
  Tsuyoshi

  Tsuyoshi Ito
  Institute for Quantum Computing, University of Waterloo
  http://www.cs.uwaterloo.ca/~tito/