Add more documentation examples #35
Draft
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
milesfrain
commented
May 2, 2021
Comment on lines
+28
to
+32
| -- | unfoldr1 g 3 == NEA.cons' 3 [2, 1, 0] | ||
| -- | unfoldr1 g 3 == NEL.cons' 3 (2 : 1 : 0 : Nil) | ||
| -- | -- Also produces structures of types which can be empty | ||
| -- | unfoldr1 g 3 == [3, 2, 1, 0] | ||
| -- | unfoldr1 g 3 == 3 : 2 : 1 : 0 : Nil |
There was a problem hiding this comment.
Wondering if this REPL-style sequence is clearer:
> unfoldr1 g 3 :: NonEmptyArray Int
(NonEmptyArray [3,2,1,0])
> unfoldr1 g 3 :: NonEmptyList _
(NonEmptyList (NonEmpty 3 (2 : 1 : 0 : Nil)))
> unfoldr1 g 3 :: Array _
[3,2,1,0]
> unfoldr1 g 3 :: List _
(3 : 2 : 1 : 0 : Nil)Also, there's some inconsistency with show for NonEmptyArray vs NonEmptyList. The Array version is a lot more concise.
milesfrain
commented
May 2, 2021
Comment on lines
+95
to
+98
| -- | > replicate1A 2 (randomInt 1 10) :: Effect (NonEmptyList Int) | ||
| -- | (NonEmptyList (NonEmpty 8 (2 : Nil))) | ||
| -- | > replicate1A 0 (randomInt 1 10) :: Effect (NEL.NonEmptyList Int) | ||
| -- | (NonEmptyList (NonEmpty 4 Nil)) | ||
| -- | > replicate1A 0 (randomInt 1 10) :: _ (NonEmptyArray _) | ||
| -- | (NonEmptyArray [3]) |
There was a problem hiding this comment.
Should these work too? Missing Traversable1:
replicate1A 0 (randomInt 1 10) :: _ (List _)
replicate1A 2 (randomInt 1 10) :: _ (Array _)
milesfrain
commented
May 2, 2021
Comment on lines
123
to
125
| -- | range 0 0 == (NEL.singleton 0 :: NEL.NonEmptyList Int) | ||
| -- | range 1 2 == (NEL.cons 1 (NEL.singleton 2) :: NEL.NonEmptyList Int) | ||
| -- | range 2 0 == (NEL.cons 2 (NEL.cons 1 (NEL.singleton 0)) :: NEL.NonEmptyList Int) |
There was a problem hiding this comment.
Writing the Non-empty examples is kinda clumsy without purescript/purescript-lists#190
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
In Progress
Description of the change
Fixes #31
Adding some more description and examples
Checklist: