docs(curry): Update docs for curry
#541
Open
+15
−69
Conversation
This file contains 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
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
mass2527
commented
Sep 16, 2024
Comment on lines
-112
to
-135
| /** | ||
| * Curries a function, allowing it to be called with a single argument at a time and returning a new function that takes the next argument. | ||
| * This process continues until all arguments have been provided, at which point the original function is called with all accumulated arguments. | ||
| * | ||
| * @param {(...args: any[]) => any} func - The function to curry. | ||
| * @returns {(...args: any[]) => any} A curried function that can be called with a single argument at a time. | ||
| * | ||
| * @example | ||
| * function sum(a: number, b: number, c: number) { | ||
| * return a + b + c; | ||
| * } | ||
| * | ||
| * const curriedSum = curry(sum); | ||
| * | ||
| * // The parameter `a` should be given the value `10`. | ||
| * const sum10 = curriedSum(10); | ||
| * | ||
| * // The parameter `b` should be given the value `15`. | ||
| * const sum25 = sum10(15); | ||
| * | ||
| * // The parameter `c` should be given the value `5`. The function 'sum' has received all its arguments and will now return a value. | ||
| * const result = sum25(5); | ||
| */ | ||
| export function curry(func: (...args: any[]) => any): (...args: any[]) => any; |
There was a problem hiding this comment.
I think if we don’t support more than 5 parameters, we don’t need to write an overload signature for it. I think not supporting it is better than supporting it with incorrect types. What do you think about this?
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #541 +/- ##
==========================================
- Coverage 99.29% 99.23% -0.06%
==========================================
Files 220 220
Lines 1835 1835
Branches 500 500
==========================================
- Hits 1822 1821 -1
- Misses 12 13 +1
Partials 1 1 |
mass2527
commented
Sep 16, 2024
Comment on lines
-136
to
-159
|
|
||
| /** | ||
| * Curries a function, allowing it to be called with a single argument at a time and returning a new function that takes the next argument. | ||
| * This process continues until all arguments have been provided, at which point the original function is called with all accumulated arguments. | ||
| * | ||
| * @param {(...args: any[]) => any} func - The function to curry. | ||
| * @returns {(...args: any[]) => any} A curried function that can be called with a single argument at a time. | ||
| * | ||
| * @example | ||
| * function sum(a: number, b: number, c: number) { | ||
| * return a + b + c; | ||
| * } | ||
| * | ||
| * const curriedSum = curry(sum); | ||
| * | ||
| * // The parameter `a` should be given the value `10`. | ||
| * const sum10 = curriedSum(10); | ||
| * | ||
| * // The parameter `b` should be given the value `15`. | ||
| * const sum25 = sum10(15); | ||
| * | ||
| * // The parameter `c` should be given the value `5`. The function 'sum' has received all its arguments and will now return a value. | ||
| * const result = sum25(5); | ||
| */ |
There was a problem hiding this comment.
Since the overloaded signatures already have good JSDoc, we can delete this jsdoc of function implementation and keep only the necessary sections.
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.
I've updated the documentation to fix inaccuracies and improve readability. I also removed sections that I think are unnecessary.