From 2a03704d2eebcc1dbb32b9db85efe55759d14a1a Mon Sep 17 00:00:00 2001 From: Jon Rowe Date: Fri, 2 Feb 2024 09:11:34 +0000 Subject: [PATCH] cleanup --- Changelog.md | 4 ++-- lib/rspec/core/configuration.rb | 7 +++---- 2 files changed, 5 insertions(+), 6 deletions(-) diff --git a/Changelog.md b/Changelog.md index 1ff6e05a7..7733227e5 100644 --- a/Changelog.md +++ b/Changelog.md @@ -12,8 +12,8 @@ Enhancements: * Allow specifying custom ordering strategies via `--order`. (Jon Rowe, #3025) * Use the improved `syntax_suggest` output for `SyntaxError` when available. (Richard Schneeman, #3015, #3026) -* Add `full_cause_backtrace` config option to print the entire cause backtrace. - (David Taylor, #3046) +* Add config option (`RSpec::Core::Configuration#full_cause_backtrace`) to print the + entire backtrace of an exception cause. (David Taylor, #3046) Bug fixes: diff --git a/lib/rspec/core/configuration.rb b/lib/rspec/core/configuration.rb index 446e21321..cef3e813a 100644 --- a/lib/rspec/core/configuration.rb +++ b/lib/rspec/core/configuration.rb @@ -453,14 +453,13 @@ def shared_context_metadata_behavior=(value) add_setting :threadsafe # @macro add_setting - # Maximum count of failed source lines to display in the failure reports. - # (default `10`). + # Maximum count of failed source lines to display in the failure reports + # (defaults to `10`). # return [Integer] add_setting :max_displayed_failure_line_count # @macro full_cause_backtrace - # Display the full backtrace of causing exceptions - # (default false). + # Display the full backtrace of an exceptions cause (defaults to `false`). # return [Boolean] add_setting :full_cause_backtrace