siblings: explain, that original elements might be returned, too #678
Conversation
This file contains hidden or 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
This edit is motivated by <jquery/jquery#2149>.
|
It seems, I've signed the CLA before with another email address. I have now used the one from this commit header to re-sign. |
|
Seems like a reasonable clarification! |
| @@ -26,7 +26,7 @@ | |||
| $( "li.third-item" ).siblings().css( "background-color", "red" ); | |||
| </code></pre> | |||
| <p>The result of this call is a red background behind items 1, 2, 4, and 5. Since we do not supply a selector expression, all of the siblings are part of the object. If we had supplied one, only the matching items among these four would be included.</p> | |||
| <p>The original element is not included among the siblings, which is important to remember when we wish to find all elements at a particular level of the DOM tree.</p> | |||
| <p>The original element is not included among the siblings, which is important to remember when we wish to find all elements at a particular level of the DOM tree. However, if the original set contains more than one element, they might be mutual siblings and will both be found. If you need an exclusive list of siblings, use <code>$set.siblings().not($set)</code>.</p> | |||
There was a problem hiding this comment.
Nitpick about the wording: In general we've been using collection or just jQuery object, not set in most of the documentation. Especially since these days set might confuse beginners (ES6 Sets, Angular $set method, ...)
Thanks to @arthurvr for pointing it out.
|
I updated the wording. Thanks, @arthurvr! |
|
Thanks! Good to land I think? |
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.
This edit is motivated by jquery/jquery#2149. It might come as surprise, that
$(':even').siblings() != $(':odd'). This commit explains this behaviour and how to create a disjunct set, if needed.I have already signed the CLA.