1
0
Fork 0
mirror of https://github.com/rails/rails.git synced 2022-11-09 12:12:34 -05:00
This commit is contained in:
Carson McDonald 2013-04-05 23:15:04 -04:00
parent 25ea7e96f3
commit b75c0bb378

View file

@ -126,8 +126,8 @@ module ActionView
# Extracts an excerpt from +text+ that matches the first instance of +phrase+. # Extracts an excerpt from +text+ that matches the first instance of +phrase+.
# The <tt>:radius</tt> option expands the excerpt on each side of the first occurrence of +phrase+ by the number of characters # The <tt>:radius</tt> option expands the excerpt on each side of the first occurrence of +phrase+ by the number of characters
# defined in <tt>:radius</tt> (which defaults to 100). If the excerpt radius overflows the beginning or end of the +text+, # defined in <tt>:radius</tt> (which defaults to 100). If the excerpt radius overflows the beginning or end of the +text+,
# then the <tt>:omission</tt> option (which defaults to "...") will be prepended/appended accordingly. The # then the <tt>:omission</tt> option (which defaults to "...") will be prepended/appended accordingly. Use the
# <tt>:separator</tt> enable to choose the delimation. The resulting string will be stripped in any case. If the +phrase+ # <tt>:separator</tt> option to choose the delimitation. The resulting string will be stripped in any case. If the +phrase+
# isn't found, nil is returned. # isn't found, nil is returned.
# #
# excerpt('This is an example', 'an', radius: 5) # excerpt('This is an example', 'an', radius: 5)
@ -145,7 +145,7 @@ module ActionView
# excerpt('This is also an example', 'an', radius: 8, omission: '<chop> ') # excerpt('This is also an example', 'an', radius: 8, omission: '<chop> ')
# # => <chop> is also an example # # => <chop> is also an example
# #
# excerpt('This is a very beautiful morning', 'very', separator: ' ', radius: 1) # excerpt('This is a very beautiful morning', 'very', separator: ' ', radius: 1)
# # => ...a very beautiful... # # => ...a very beautiful...
def excerpt(text, phrase, options = {}) def excerpt(text, phrase, options = {})
return unless text && phrase return unless text && phrase