Document that key is only called for subsequent keys. #46
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
I was quite confused that key is never called for the first key in an object. I now see how that data is only available in openobject, so tried to clarify that in the docs.
|
The behavior is indeed confusing, and while it cannot be addressed without major breaking changes, I do believe that option warrants some discussion, perhaps for a v1.0 milestone. In the mean time I'll accept this clarification of current behavior. |
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 quite confused that key is never called for the first key in an
object. I now see how that data is only available in openobject, so
tried to clarify that in the docs.