patch applied (packages/base): In docs for unsafeCoerce,
point to unsafeCoerce#
Ian Lynagh
igloo at earth.li
Wed Apr 23 09:51:50 EDT 2008
On Tue, Apr 22, 2008 at 09:20:12AM +0100, Simon Peyton-Jones wrote:
> | > Ah, good point. How do we say "GHC only" in documentation? In words? Or with #ifdef?
> |
> | It's better to have the same documentation for everyone, with words about
> | what's implementation-specific.
>
> The words in Unsafe.Coerce are these:
>
> -- 'unsafeCoerce' is just a trivial wrapper for 'unsafeCoerce#';
> -- see the latter for important documentation about correct usage.
>
> If this is Haddock'd for NHC, the link to unsafeCoerce# will yield an error message, I suppose, even if we precede with "In GHC, 'unsafeCoerce' is just..."
This is just a warning so, while not ideal, it will work.
Thanks
Ian
More information about the Cvs-libraries
mailing list