Add changelog entries since v5.3.1 #209
Conversation
CHANGELOG.md
Outdated
| - Added monomorphic `foldl` `foldr` `foldMap` `fold` `intercalate` to `Array` (#201) | ||
| - These are just wrapped versions from `Data.Foldable` | ||
| - Added monomorphic `foldl1` `foldr1` `foldMap1` `foldl1` `intercalate` to `Array.NonEmpty` (#201) | ||
| - These are just wrapped versions from `Data.Foldable` |
There was a problem hiding this comment.
I'm not sure "wrapped versions" is the correct terminology here; @hdgarrood, do you have a suggestion?
There was a problem hiding this comment.
Yeah, I think “wrapped” suggests that actually you’ve done something to them, whereas all we’ve done here is specialize. I’d suggest “specialized versions of the functions with the same names from Data.Foldable”. Is that true for all of these though? This shouldn’t be a separate bullet point either, it’s part of the same change.
There was a problem hiding this comment.
To be clear, the one I’m not sure about is intercalate - I thought it was supposed to get its own Array-specific implementation.
There was a problem hiding this comment.
This shouldn’t be a separate bullet point either, it’s part of the same change.
It's indented, to indicate a clarification rather than an entire new point, but I think it reads a little better as just sentences in the same bullet point and agree it should just merge into the previous line.
CHANGELOG.md
Outdated
| - Added specialized monomorphic functions from `Data.Foldable` (#201): | ||
| - Added `foldl`, `foldr`, `foldMap`, `fold`, `intercalate` to `Array` | ||
| - Added `foldl1`, `foldr1`, `foldMap1`, `foldl1`, `intercalate` to `Array.NonEmpty` |
There was a problem hiding this comment.
Reorganized the nested bullets to cut down on duplication. What's the follow-up step for intercalate mentioned in the earlier discussion?
There was a problem hiding this comment.
The question is whether intercalate should get its own Array specific implementation (for performance) rather than just being a specialization of the intercalate from Data.Foldable. I think it probably should, or at least we should measure to see if an Array-based implementation would speed it up, but I suppose that doesn’t need to happen right now.
There was a problem hiding this comment.
I've opened #210 to track this.
CHANGELOG.md
Outdated
|
|
||
| New features: | ||
| - Added specialized monomorphic functions from `Data.Foldable` (#201): |
There was a problem hiding this comment.
I actually find this a bit confusing, because these functions aren’t actually from Data.Foldable, they’re versions of those functions. I’d suggest “Added specialized versions of the functions from Data.Foldable”. Saying they’re specialized is the same thing as saying they’re monomorphic, and I think using both words makes this a bit harder to parse.
There was a problem hiding this comment.
What about
Exported monomorphic functions from
Data.Foldable(i.e.fis forced to beArray)
It doesn't include the HeytingAlgebra being forced to be Boolean changes we also made (e.g. all, any), but that's the heart of it.
There was a problem hiding this comment.
I still prefer to say “Added specialized versions of the functions from Data.Foldable“. My problem is with saying the functions are from Data.Foldable (as opposed to being versions of the functions from Data.Foldable).
There was a problem hiding this comment.
I think only one minor change needs to be made before this can be merged.
Thanks for tackling this @milesfrain!
Description of the change
This PR updates the CHANGELOG in preparation for the upcoming release of this library.
Related: purescript/purescript#3985