Document Regexp#multiline? [ci-skip]

`Regexp#multiline?` has been publicized in the Active Support Core
Extensions guide for a while now.  This commit adds matching API docs.
This commit is contained in:
Jonathan Hefner 2020-11-11 16:03:02 -06:00
parent 8435250167
commit b20ac9a1d3
1 changed files with 8 additions and 1 deletions

View File

@ -1,6 +1,13 @@
# frozen_string_literal: true
class Regexp #:nodoc:
class Regexp
# Returns +true+ if the regexp has the multiline flag set.
#
# (/./).multiline? # => false
# (/./m).multiline? # => true
#
# Regexp.new(".").multiline? # => false
# Regexp.new(".", Regexp::MULTILINE).multiline? # => true
def multiline?
options & MULTILINE == MULTILINE
end