-
Notifications
You must be signed in to change notification settings - Fork 3
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[WIP] Improve docs #2
base: master
Are you sure you want to change the base?
Conversation
nate00
commented
May 12, 2016
•
edited
Loading
edited
- Method docs
- Class docs
- Implementation details
- Complete examples
# [+#{attribute_name}_key+] | ||
# The key in Memcached that stores the count. | ||
# [+#{attribute_name}_count=(value)+] | ||
# Sets the value of the count. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
i think it might be worth adding parenthetically here that you don't need to call this except for testing
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah, I was actually just about to remove mention of this method. Similarly, I wasn't going to document {increment,decrement}_*_count
. Do you think there's value in mentioning any of those?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
you might, in fact, want to use them in testing, so mentioning somewhere seems good