Minor documentation updates

This commit is contained in:
Robert Speicher 2015-05-14 17:09:02 -04:00
parent b88da58cb6
commit 1a277c5025
2 changed files with 2 additions and 2 deletions

View File

@ -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}"

View File

@ -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"}