diff options
| author | Herbert Valerio Riedel <hvr@gnu.org> | 2014-09-13 18:14:55 +0200 |
|---|---|---|
| committer | Herbert Valerio Riedel <hvr@gnu.org> | 2014-09-13 18:20:18 +0200 |
| commit | abff2ffd2d6e30b93daa0def282b9fc0795ad10d (patch) | |
| tree | b15b7c23862b9526d7e805616592228b704b2649 /libraries/base/Prelude.hs | |
| parent | 6999223fbb95046fe08562559bba1fdeb7d16795 (diff) | |
| download | haskell-abff2ffd2d6e30b93daa0def282b9fc0795ad10d.tar.gz | |
Move docstring of `seq` to primops.txt.pp
The documentation for `seq` was recently augmented via #9390 &
cbfa107604f4cbfaf02bd633c1faa6ecb90c6dd7. However, it doesn't show
up in the Haddock generated docs because `#ifdef __HADDOCK__` doesn't
work as expected. Also, it's easier to just fix the problem at the
origin (which in this is case is the primops.txt.pp file).
The benefit/downside of this is that now the extended documentation
shows up everywhere `seq` is re-exported directly.
Diffstat (limited to 'libraries/base/Prelude.hs')
| -rw-r--r-- | libraries/base/Prelude.hs | 16 |
1 files changed, 0 insertions, 16 deletions
diff --git a/libraries/base/Prelude.hs b/libraries/base/Prelude.hs index 12a3d8f59a..f58cd17cd2 100644 --- a/libraries/base/Prelude.hs +++ b/libraries/base/Prelude.hs @@ -150,19 +150,3 @@ import GHC.Num import GHC.Real import GHC.Float import GHC.Show - - -#ifdef __HADDOCK__ --- | The value of @'seq' a b@ is bottom if @a@ is bottom, and otherwise --- equal to @b@. 'seq' is usually introduced to improve performance by --- avoiding unneeded laziness. --- --- A note on evaluation order: the expression @seq a b@ does /not/ guarantee --- that @a@ will be evaluated before @b@. The only guarantee given by @seq@ is --- that the both @a@ and @b@ will be evaluated before @seq@ returns a value. In --- particular, this means that @b@ may be evaluated before @a@. If you need to --- guarantee a specific order of evaluation, you must use the function @pseq@ --- from the parallel package. -seq :: a -> b -> b -seq _ y = y -#endif |