From 1a277c502590fbdb652f73ec3c0974ff70ea5416 Mon Sep 17 00:00:00 2001
From: Robert Speicher <rspeicher@gmail.com>
Date: Thu, 14 May 2015 17:09:02 -0400
Subject: [PATCH] Minor documentation updates

---
 app/models/concerns/mentionable.rb | 2 +-
 app/models/concerns/referable.rb   | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)

diff --git a/app/models/concerns/mentionable.rb b/app/models/concerns/mentionable.rb
index f28b20afd8..9b29988947 100644
--- a/app/models/concerns/mentionable.rb
+++ b/app/models/concerns/mentionable.rb
@@ -25,7 +25,7 @@ module Mentionable
   # By default this will be the class name and the result of calling
   # `to_reference` on the object.
   def gfm_reference
-    # Convert "MergeRequest" to "merge request"
+    # "MergeRequest" > "merge_request" > "Merge request" > "merge request"
     friendly_name = self.class.to_s.underscore.humanize.downcase
 
     "#{friendly_name} #{to_reference}"
diff --git a/app/models/concerns/referable.rb b/app/models/concerns/referable.rb
index e3c1c6d268..5f57846b58 100644
--- a/app/models/concerns/referable.rb
+++ b/app/models/concerns/referable.rb
@@ -40,7 +40,7 @@ module Referable
     #
     # This must be overridden by the including class.
     #
-    # Returns Regexp
+    # Returns a Regexp
     def reference_pattern
       raise NotImplementedError,
         %Q{#{self} does not implement "reference_pattern"}