fix documentation: sigil cops autocorrect using suggested level

Shopify · Dec 19, 2024 · 04450e5 · 04450e5
1 parent 0b3d4ac
commit 04450e5
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 0 deletions.
diff --git a/lib/rubocop/cop/sorbet/sigils/has_sigil.rb b/lib/rubocop/cop/sorbet/sigils/has_sigil.rb
@@ -13,6 +13,7 @@ module Sorbet
       # * `SuggestedStrictness`: Sorbet strictness level suggested in offense messages (default: 'false')
       # * `MinimumStrictness`: If set, make offense if the strictness level in the file is below this one
       #
+      # If a `SuggestedStrictness` level is specified, it will be used in autocorrect.
       # If a `MinimumStrictness` level is specified, it will be used in offense messages and autocorrect.
       class HasSigil < ValidSigil
         def require_sigil_on_all_files?

diff --git a/lib/rubocop/cop/sorbet/sigils/valid_sigil.rb b/lib/rubocop/cop/sorbet/sigils/valid_sigil.rb
@@ -16,6 +16,7 @@ module Sorbet
       # * `ExactStrictness`: If set, make offense if the strictness level in the file is different than this one
       #
       # If an `ExactStrictness` level is specified, it will be used in offense messages and autocorrect.
+      # If a `SuggestedStrictness` level is specified, it will be used in autocorrect.
       # Otherwise, if a `MinimumStrictness` level is specified, it will be used in offense messages and autocorrect.
       class ValidSigil < RuboCop::Cop::Base
         extend AutoCorrector