From 10f5d658b232a2ea1d26f3da400d42587764990c Mon Sep 17 00:00:00 2001
From: Raphael Sofaer <raphael@joindiaspora.com>
Date: Tue, 14 Jun 2011 10:15:32 -0700
Subject: [PATCH] Document liked? and like_for

---
 app/models/user.rb | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/app/models/user.rb b/app/models/user.rb
index 477c96f8a..61abd291d 100644
--- a/app/models/user.rb
+++ b/app/models/user.rb
@@ -170,6 +170,8 @@ class User < ActiveRecord::Base
     build_relayable(Like, options)
   end
 
+  # Check whether the user has liked a post.  Extremely inefficient if the post's likes are not loaded.
+  # @param [Post] post
   def liked?(post)
     if self.like_for(post)
       return true
@@ -178,6 +180,9 @@ class User < ActiveRecord::Base
     end
   end
 
+  # Get the user's like of a post, if there is one.  Extremely inefficient if the post's likes are not loaded.
+  # @param [Post] post
+  # @return [Like]
   def like_for(post)
     [post.likes, post.dislikes].each do |likes|
       likes.each do |like|