Add information about unapply method #1573
Merged
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
The documentation currently just states "we're calling the unapply method", without giving any indication to *how* it's being called. Saying something like "we're calling the unapply method with `CustomerID.unapply(customer1ID)`" or "we're calling the unapply method with `name=CustomerID.unapply(customer1ID)`", while maybe not strictly accurate, helps give readers a better understanding of what's going on. I know for me personally I found this very confusing, and a line or two about this would have been very helpful.
|
thank you! |
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.
The documentation currently just states "we're calling the unapply method", without giving any indication to how it's being called initially. Saying something like "we're calling the unapply method with
CustomerID.unapply(customer1ID)" or "we're calling the unapply method withname=CustomerID.unapply(customer1ID)" earlier, while maybe not strictly accurate, helps give readers a better understanding of what's going on. I think we should move (or copy) the section that starts with "This is equivalent to..." up above, and reiterate the point below. I know for me personally I found this very confusing, and a line or two about this earlier would have been very helpful.