Skip to content

Commit 6ddee1b

Browse files
Add clearer docs for Prelude module (#270)
1 parent 1270758 commit 6ddee1b

File tree

2 files changed

+13
-0
lines changed

2 files changed

+13
-0
lines changed

CHANGELOG.md

+1
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ Bugfixes:
1212

1313
Other improvements:
1414
- Changed `unit`'s FFI representation from `{}` to `undefined` (#267 by @JordanMartinez)
15+
- Added clearer docs for Prelude module (#270 by @JordanMartinez)
1516
- Clarify docs for `flip` (#271 by @JordanMartinez)
1617

1718
## [v5.0.1](https://github.com/purescript/purescript-prelude/releases/tag/v5.0.1) - 2021-05-11

src/Prelude.purs

+12
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,15 @@
1+
-- | `Prelude` is a module that re-exports many other foundational modules from the `purescript-prelude` library
2+
-- | (e.g. the Monad type class hierarchy, the Monoid type classes, Eq, Ord, etc.).
3+
-- |
4+
-- | Typically, this module will be imported in most other libraries and projects as an open import.
5+
-- |
6+
-- | ```
7+
-- | module MyModule where
8+
-- |
9+
-- | import Prelude -- open import
10+
-- |
11+
-- | import Data.Maybe (Maybe(..)) -- closed import
12+
-- | ```
113
module Prelude
214
( module Control.Applicative
315
, module Control.Apply

0 commit comments

Comments
 (0)