Add examples #36
Add examples #36
Conversation
| -- | nonEmptyArray :: NonEmpty Array Int | ||
| -- | nonEmptyArray = NonEmpty 1 [2,3] | ||
| -- | | ||
| -- | import Data.List(List(..), (:)) |
There was a problem hiding this comment.
It might be preferable to move the import declarations to the top, as you aren't allowed to have any import declarations after the first non-import declaration in a module.
There was a problem hiding this comment.
I was trying to match the style of using the repl, and keeping things logically clustered. I guess it's a question of whether this slight addition of clarity/organization outweighs the confusion if someone pastes this into a .purs file. I think the error message is pretty clear though in that case.
Luckily this won't be a concern with doctest (repl style).
There was a problem hiding this comment.
Is this a blocker? I'm fine with changing it, but it doesn't seem too consequential either way, so I'll spare the effort if it's unnecessary.
There was a problem hiding this comment.
No, it’s just that changes to the core libraries should generally obtain two core team approvals, see https://github.com/purescript/governance
src/Data/NonEmpty.purs
Outdated
| -- | For example: | ||
| -- | |
There was a problem hiding this comment.
I think we typically don't include "For example:" just to save on the editor tooltips so the example is closer to hand. We could go straight to the example:
-- | Get the 'first' element of a non-empty container
-- |
-- | ```purescript
-- | head (1 :| [2, 3]) == 1
-- | ```There was a problem hiding this comment.
Was following precedent set by existing docs in this file. Will remove this phrasing from all of them.
There was a problem hiding this comment.
Ah, I didn't realize. Thank you for removing that.
| -- | Apply a function that takes the `first` element and remaining elements | ||
| -- | as arguments to a non-empty container. | ||
| -- | | ||
| -- | For example, return the remaining elements multiplied by the first element: |
There was a problem hiding this comment.
Keeping this additional example clarification.
No description provided.