[WIP] Improve docs #2

nate00 · 2016-05-12T04:04:43Z

Method docs
Class docs
Implementation details
Complete examples

djudd · 2016-05-12T14:06:38Z

lib/cached_counts.rb

+    # [+#{attribute_name}_key+]
+    #   The key in Memcached that stores the count.
+    # [+#{attribute_name}_count=(value)+]
+    #   Sets the value of the count.


i think it might be worth adding parenthetically here that you don't need to call this except for testing

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?

you might, in fact, want to use them in testing, so mentioning somewhere seems good

djudd reviewed May 12, 2016
View reviewed changes

nate00 force-pushed the documentation branch from a0858ce to dca4be6 Compare May 18, 2016 05:16

Docs: Improve method docs.

c22789f

nate00 force-pushed the documentation branch from dca4be6 to c22789f Compare May 18, 2016 05:18

nate00 added 3 commits May 17, 2016 22:20

Docs: Add (tiny) module docs

cbf9caa

[WIP] implementation/caveats/?? doc

0ba06ea

README: Note that gem and requireable name differ

d5bed1f

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[WIP] Improve docs #2

[WIP] Improve docs #2

nate00 commented May 12, 2016 •

edited

djudd May 12, 2016

nate00 May 12, 2016

djudd May 12, 2016

[WIP] Improve docs #2

Are you sure you want to change the base?

[WIP] Improve docs #2

Conversation

nate00 commented May 12, 2016 • edited

djudd May 12, 2016

Choose a reason for hiding this comment

nate00 May 12, 2016

Choose a reason for hiding this comment

djudd May 12, 2016

Choose a reason for hiding this comment

nate00 commented May 12, 2016 •

edited