Skip to content

[WIP] Improve docs#2

Open
nate00 wants to merge 4 commits into
masterfrom
documentation
Open

[WIP] Improve docs#2
nate00 wants to merge 4 commits into
masterfrom
documentation

Conversation

@nate00

@nate00 nate00 commented May 12, 2016

Copy link
Copy Markdown
Member
  • Method docs
  • Class docs
  • Implementation details
  • Complete examples

Comment thread lib/cached_counts.rb Outdated
# [+#{attribute_name}_key+]
# The key in Memcached that stores the count.
# [+#{attribute_name}_count=(value)+]
# Sets the value of the count.

Copy link
Copy Markdown

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

Copy link
Copy Markdown
Member Author

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?

Copy link
Copy Markdown

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants