Fix API docs inconsistencies #3
Merged
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
klaudiosinani
added
the
docs
klaudiosinani
requested changes
Nov 19, 2018
There was a problem hiding this comment.
Looks great! We can replace appendTo with append on lines 137 & 138 and it is good to be merged 👌
| assignWith(10)('a')({ a: 1, b: 2 }) //=> { a: 10, b: 2} | ||
| assign(10, 'a', { a: 1, b: 2 }) //=> { a: 10, b: 2} | ||
| assign(10, 'a')({ a: 1, b: 2 }) //=> { a: 10, b: 2} | ||
| assign(10)('a')({ a: 1, b: 2 }) //=> { a: 10, b: 2} |
| @@ -315,7 +313,7 @@ Accepts a number `n`, a function `fn`, and returns a wrapper function of `fn` wi | |||
| ```js | |||
| const array2 = binary(array) | |||
|
|
|||
| array2(1, 2) //=> 1 2 | |||
| array2(1, 2) //=> [1, 2] | |||
| drop(3, 'foo..') //=> '...' | ||
| drop(3)('foo..') //=> '...' | ||
| drop(3, 'foo...') //=> '...' | ||
| drop(3)('foo...') //=> '...' |
klaudiosinani
approved these changes
Nov 19, 2018
|
No problem, I'll check the rest of the docs later. Do you need any help writing tests or anything else? |
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 was reading through the docs and noticed some inconsistencies:
appendTocalls inappendexamplesassignWithcalls instead ofassigninassignexamplesarray2(1, 2)drop3examples weren't correctI haven't finished reading the docs (I'm at work and it's a lot to read through) but I can check the rest for inconsistencies later if it could be of help.