README: Document passing friendship to after callbacks #3
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
ericboehs
changed the title
|
This is awesome, had no idea you could do that haha 👍 Wanna throw some inline comments just clarifying that you can also use the sym if you don't care about the object being passed in the callback and/or adding an example? http://rdoc.info/github/thejchap/popular/frames Looks good. Thanks! |
|
I added inline documentation. Let me know if I missed anything. |
Documentation doesn't mention how to access the friend being followed/unfollowed from `after` callbacks. I document my adventures on how I discovered this [here](https://gist.github.com/ericboehs/ccc6b78349fc32e5f1bb). By the way, the `value` is returned when creating the friendship. Therefore, `value` will be `nil` for before callbacks. This is because it is being called *before* the friendship code is ever ran.
thejchap
added a commit
that referenced
this pull request
Jun 19, 2014
README: Document passing friendship to after callbacks
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.
Documentation doesn't mention how to access the friend being followed/unfollowed from
aftercallbacks. I document my adventures on how I discovered this here.By the way, the
valueis returned when creating the friendship. Therefore,valuewill benilfor before callbacks. This is because it is being called before the friendship creation code is ever ran.Also, inline code documentation should probably be updated too.