Clarify in the docs which object is the considered the "old" vs "new". #7
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
Some diff'ing functions, particularly for testing use the sematics of `diff(actual,expected)`. You see this for example in the `unfunk-diff` library uses this library. Other tools like this one use the sematics of `diff(old,new)`. Either can make sense, but it's not clear which semantics are being used when the example arguments are 'ObjectA' and 'ObjectB'. Updating the example input names clarify which semantics are being used here.
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.
Some diff'ing functions, particularly for testing use the sematics of
diff(actual,expected). You see this for example in theunfunk-difflibrary uses this library.Other tools like this one use the sematics of
diff(old,new). Either can make sense, but it's not clear which semantics are being used when the example arguments are 'ObjectA' and 'ObjectB'.Updating the example input names clarify which semantics are being used here.