[Fix rubocop#9328] Add co-author, simple documentation

thearjunmdas · Aug 22, 2021 · a89c08b · a89c08b
1 parent 4a13649
commit a89c08b
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 1 deletion.
diff --git a/changelog/change_recognize_shareable_constant_value_magic.md b/changelog/change_recognize_shareable_constant_value_magic.md
@@ -1 +1 @@
-* [#9328](https://github.com/rubocop/rubocop/issues/9328): Recognize shareable_constant_value magic comment. ([@thearjunmdas][])
+* [#9328](https://github.com/rubocop/rubocop/issues/9328): Recognize shareable_constant_value magic comment. ([@thearjunmdas][], [@caalberts][])
diff --git a/lib/rubocop/cop/style/mutable_constant.rb b/lib/rubocop/cop/style/mutable_constant.rb
@@ -14,6 +14,11 @@ module Style
       # positives. Luckily, there is no harm in freezing an already
       # frozen object.
       #
+      # From Ruby 3.0, this cop honours the magic comment
+      # 'shareable_constant_value'. When this magic comment is set to any
+      # acceptable value other than none, it will suppress the offenses
+      # raised by this cop. It enforces frozen state.
+      #
       # NOTE: Regexp and Range literals are frozen objects since Ruby 3.0.
       #
       # @example EnforcedStyle: literals (default)