Add docs to path.
#3010
Merged
Add docs to path.
#3010
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
CrossEye
requested changes
Apr 10, 2020
|
Such suggestions are always welcome! In this case, I disagree on the details. I'll try to think of some more comprehensive text this weekend. |
|
👍 Let me know if there's more I can do to help. |
|
Yeah, sorry. I dropped this entirely. I will look again. |
CrossEye
requested changes
May 9, 2020
source/path.js
Outdated
| @@ -11,7 +13,7 @@ import paths from './paths'; | |||
| * @typedefn Idx = String | Int | |||
| * @sig [Idx] -> {a} -> a | Undefined | |||
| * @param {Array} path The path to use. | |||
| * @param {Object} obj The object to retrieve the nested property from. | |||
| * @param {Object} obj The object or array to retrieve the nested property from. | |||
| * @return {*} The data at `path`. | |||
| * @see R.prop, R.nth | |||
There was a problem hiding this comment.
We should also mention assocPath/dissocPath here.
customcommander
force-pushed
the
add-path-docs
branch
from
fdda00c
to
93e14f0
Compare
|
@CrossEye I rebased against the master branch and added your suggestions. |
CrossEye
approved these changes
Jan 22, 2022
|
Oops I totally forgot about this, thanks for carrying it across the finish line, @customcommander! |
Closed
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.
Addresses discussion and suggestions in #3007 to clarify documentation of
path.I'm not sure if any of these doc edits would be welcome, but I thought I'd at least offer them. Feel free to tweak or reject if it doesn't match the style.