Update _.object and _.pairs docs to show relation #2583
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
Long time user, first time contributor. Reading through this well-documented source code, I noticed the link between _.pairs and _.object for the first time. As presented, these 2 related functions are far away from each other (with good reason), so I suggest this highlighting the connection in the annotations.
captbaritone
requested changes
Oct 2, 2016
| @@ -1015,7 +1015,8 @@ <h2 id="arrays">Array Functions</h2> | |||
| <b class="header">object</b><code>_.object(list, [values])</code> | |||
| <br /> | |||
| Converts arrays into objects. Pass either a single list of | |||
| <tt>[key, value]</tt> pairs, or a list of keys, and a list of values. | |||
| <tt>[key, value]</tt> pairs, or a list of keys, and a list of values. The former | |||
| usage is invertible through <code>_.pairs</code>. | |||
There was a problem hiding this comment.
I'm on-board with this change, but I'm not sure to what "The former usage" refers. Could you reword?
| @@ -1424,7 +1425,8 @@ <h2 id="objects">Object Functions</h2> | |||
| <p id="pairs"> | |||
| <b class="header">pairs</b><code>_.pairs(object)</code> | |||
| <br /> | |||
| Convert an object into a list of <tt>[key, value]</tt> pairs. | |||
| Convert an object into a list of <tt>[key, value]</tt> pairs. Inverse of first | |||
| usage of <code>_.object</code>. | |||
There was a problem hiding this comment.
Inverse of first usage of
_.object.
In order to better fit with the rest of our documentation, could you reword this as a complete sentence?
There was a problem hiding this comment.
Hi @captbaritone , thanks for the feedback. Is this clearer? I tried to match the wording of other "opposites" such as in _.unescape and _.unzip.
Also -- I edited the corresponding comments in underscore.js so that the annotated source will stay consistent w/ the main page. Take a look!
|
Thanks! |
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.
Long time user, first time contributor. Reading through this well-documented source code, I noticed the link between _.pairs and _.object for the first time. As presented, these 2 related functions are far away from each other (with good reason), so I suggest this highlighting the connection in the annotations. Please let me know if there's a better contribution workflow, if I need to PR first to Underscore-Contrib, etc.