Skip to content

Commit

Permalink
Merge pull request rubocop#9881 from amomchilov/amomchilov-patch-1
Browse files Browse the repository at this point in the history
Add a link to Layout/EmptyLineAfterMagicComment
  • Loading branch information
jonas054 committed Jul 3, 2021
2 parents d1e8f9b + 984ff11 commit 33ed53a
Showing 1 changed file with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions lib/rubocop/cop/style/frozen_string_literal_comment.rb
Expand Up @@ -5,11 +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
Expand Down

0 comments on commit 33ed53a

Please sign in to comment.