8000 Reword overload phrasing · rspec/rspec@5efa326 · GitHub
[go: up one dir, main page]

Skip to content

Commit 5efa326

Browse files
committed
Reword overload phrasing
1 parent 312b9fe commit 5efa326

File tree

1 file changed

+4
-6
lines changed

1 file changed

+4
-6
lines changed

rspec-expectations/lib/rspec/expectations/configuration.rb

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -187,15 +187,13 @@ def warn_about_potential_false_positives=(boolean)
187187
end
188188
end
189189

190-
# Configuration for RSpec behaviour with matcher use that might result in false positives.
190+
# Configures what RSpec will do about matcher use which would potentially cause
191+
# false positives in tests. Defaults to `:warn` since this is generally the desired behavior,
192+
# but can also be set to `:raise` or `:nothing`.
193+
#
191194
# @overload on_potential_false_positives
192-
# Indicates how RSpec handles potential false positives in tests (default: `:warn`;
193-
# options: `:warn`, `:raise`, `:nothing`)
194195
# @return [Symbol] the behavior setting
195196
# @overload on_potential_false_positives=(value)
196-
# Configures what RSpec will do about matcher use which would potentially
197-
# cause false positives in tests. Defaults to `:warn` since this is generally
198-
# the desired behavior.
199197
# @param [Symbol] behavior can be set to `:warn`, `:raise` or `:nothing`
200198
# @return [Symbol] the behavior setting
201199
attr_reader :on_potential_false_positives

0 commit comments

Comments
 (0)
0