Commit 1a277c50 authored by Robert Speicher's avatar Robert Speicher

Minor documentation updates

parent b88da58c
...@@ -25,7 +25,7 @@ module Mentionable ...@@ -25,7 +25,7 @@ module Mentionable
# By default this will be the class name and the result of calling # By default this will be the class name and the result of calling
# `to_reference` on the object. # `to_reference` on the object.
def gfm_reference 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 = self.class.to_s.underscore.humanize.downcase
"#{friendly_name} #{to_reference}" "#{friendly_name} #{to_reference}"
......
...@@ -40,7 +40,7 @@ module Referable ...@@ -40,7 +40,7 @@ module Referable
# #
# This must be overridden by the including class. # This must be overridden by the including class.
# #
# Returns Regexp # Returns a Regexp
def reference_pattern def reference_pattern
raise NotImplementedError, raise NotImplementedError,
%Q{#{self} does not implement "reference_pattern"} %Q{#{self} does not implement "reference_pattern"}
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment