From 293109456d86fb20fd3acb197b9f14d2b97892f4 Mon Sep 17 00:00:00 2001 From: Alexander Momchilov Date: Wed, 28 Apr 2021 15:47:09 -0400 Subject: [PATCH] Add a link to Layout/EmptyLineAfterMagicComment --- lib/rubocop/cop/style/frozen_string_literal_comment.rb | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/lib/rubocop/cop/style/frozen_string_literal_comment.rb b/lib/rubocop/cop/style/frozen_string_literal_comment.rb index 02ae88825c7..2cea8ddec92 100644 --- a/lib/rubocop/cop/style/frozen_string_literal_comment.rb +++ b/lib/rubocop/cop/style/frozen_string_literal_comment.rb @@ -5,14 +5,17 @@ module Cop module Style # This cop is designed to help you transition from mutable string literals # to frozen string literals. - # It will add the comment `# frozen_string_literal: true` to the top of - # files to enable frozen string literals. Frozen string literals may be + # It will add the `# frozen_string_literal: true` magic comment to the top + # of files to enable frozen string literals. Frozen string literals may be # default in future Ruby. The comment will be added below a shebang and # encoding comment. # # Note that the cop will ignore files where the comment exists but is set # to `false` instead of `true`. # + # To require a blank line after this comment, please see + # `Layout/EmptyLineAfterMagicComment` cop. + # # @example EnforcedStyle: always (default) # # The `always` style will always add the frozen string literal comment # # to a file, regardless of the Ruby version or if `freeze` or `<<` are