Update docs for ascendNaturally and descendNaturally #3474
Merged
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.
While working on ramda/types#127 I noticed that the block comment docs are a bit off because of how these are implemented
https://github.com/ramda/ramda/pull/3442/files#diff-2f0444491e08d72d422c4e936a1e621a9a3fdb85d20da37118526f4df5bb5ddaR35
.localeCompare
only exists on the prototype ofstring
. This means that the compare function forascendNaturally
anddescendNaturally
need to returnString
, and notOrd
.Ord
is defined asnumber | string | boolean | Date
, which are the only types in javascript you can use<
,>
,<=
, and>=
on. This makes since forascend
anddescend
of course, but trying those withascendNaturally
anddescendNaturally
will give you a runtime error