Skip to content

Commit

Permalink
Unify to remove 'This cop' from cop description in each cop file
Browse files Browse the repository at this point in the history
  • Loading branch information
nobuyo authored and bbatsov committed May 13, 2022
1 parent 4448a88 commit 133ffce
Show file tree
Hide file tree
Showing 390 changed files with 390 additions and 390 deletions.
2 changes: 1 addition & 1 deletion lib/rubocop/cop/bundler/gem_filename.rb
Expand Up @@ -3,7 +3,7 @@
module RuboCop
module Cop
module Bundler
# This cop verifies that a project contains Gemfile or gems.rb file and correct
# Verifies that a project contains Gemfile or gems.rb file and correct
# associated lock file based on the configuration.
#
# @example EnforcedStyle: Gemfile (default)
Expand Down
2 changes: 1 addition & 1 deletion lib/rubocop/cop/gemspec/date_assignment.rb
Expand Up @@ -3,7 +3,7 @@
module RuboCop
module Cop
module Gemspec
# This cop checks that `date =` is not used in gemspec file.
# Checks that `date =` is not used in gemspec file.
# It is set automatically when the gem is packaged.
#
# @example
Expand Down
Expand Up @@ -3,7 +3,7 @@
module RuboCop
module Cop
module InternalAffairs
# This cop checks whether `expect_offense` and correction expectation methods
# Checks whether `expect_offense` and correction expectation methods
# (i.e. `expect_correction` and `expect_no_corrections`) are separated by empty line.
#
# @example
Expand Down
Expand Up @@ -3,7 +3,7 @@
module RuboCop
module Cop
module InternalAffairs
# This cop enforces the use of `same_line?` instead of location line comparison for equality.
# Enforces the use of `same_line?` instead of location line comparison for equality.
#
# @example
# # bad
Expand Down
2 changes: 1 addition & 1 deletion lib/rubocop/cop/internal_affairs/method_name_end_with.rb
Expand Up @@ -3,7 +3,7 @@
module RuboCop
module Cop
module InternalAffairs
# This cop checks potentially usage of method identifier predicates
# Checks potentially usage of method identifier predicates
# defined in rubocop-ast instead of `method_name.end_with?`.
#
# @example
Expand Down
Expand Up @@ -3,7 +3,7 @@
module RuboCop
module Cop
module InternalAffairs
# This cop checks for redundant `subject(:cop) { described_class.new }`.
# Checks for redundant `subject(:cop) { described_class.new }`.
#
# @example
# # bad
Expand Down
Expand Up @@ -3,7 +3,7 @@
module RuboCop
module Cop
module InternalAffairs
# This cop checks that `let` is `RuboCop::Config.new` with no arguments.
# Checks that `let` is `RuboCop::Config.new` with no arguments.
#
# @example
# # bad
Expand Down
2 changes: 1 addition & 1 deletion lib/rubocop/cop/layout/assignment_indentation.rb
Expand Up @@ -3,7 +3,7 @@
module RuboCop
module Cop
module Layout
# This cop checks the indentation of the first line of the
# Checks the indentation of the first line of the
# right-hand-side of a multi-line assignment.
#
# @example
Expand Down
2 changes: 1 addition & 1 deletion lib/rubocop/cop/layout/begin_end_alignment.rb
Expand Up @@ -3,7 +3,7 @@
module RuboCop
module Cop
module Layout
# This cop checks whether the end keyword of `begin` is aligned properly.
# Checks whether the end keyword of `begin` is aligned properly.
#
# Two modes are supported through the `EnforcedStyleAlignWith` configuration
# parameter. If it's set to `start_of_line` (which is the default), the
Expand Down
2 changes: 1 addition & 1 deletion lib/rubocop/cop/layout/block_alignment.rb
Expand Up @@ -3,7 +3,7 @@
module RuboCop
module Cop
module Layout
# This cop checks whether the end keywords are aligned properly for do
# Checks whether the end keywords are aligned properly for do
# end blocks.
#
# Three modes are supported through the `EnforcedStyleAlignWith`
Expand Down
2 changes: 1 addition & 1 deletion lib/rubocop/cop/layout/block_end_newline.rb
Expand Up @@ -3,7 +3,7 @@
module RuboCop
module Cop
module Layout
# This cop checks whether the end statement of a do..end block
# Checks whether the end statement of a do..end block
# is on its own line.
#
# @example
Expand Down
2 changes: 1 addition & 1 deletion lib/rubocop/cop/layout/case_indentation.rb
Expand Up @@ -3,7 +3,7 @@
module RuboCop
module Cop
module Layout
# This cop checks how the `when` and ``in``s of a `case` expression
# Checks how the `when` and ``in``s of a `case` expression
# are indented in relation to its `case` or `end` keyword.
#
# It will register a separate offense for each misaligned `when` and `in`.
Expand Down
2 changes: 1 addition & 1 deletion lib/rubocop/cop/layout/closing_parenthesis_indentation.rb
Expand Up @@ -3,7 +3,7 @@
module RuboCop
module Cop
module Layout
# This cop checks the indentation of hanging closing parentheses in
# Checks the indentation of hanging closing parentheses in
# method calls, method definitions, and grouped expressions. A hanging
# closing parenthesis means `)` preceded by a line break.
#
Expand Down
2 changes: 1 addition & 1 deletion lib/rubocop/cop/layout/comment_indentation.rb
Expand Up @@ -3,7 +3,7 @@
module RuboCop
module Cop
module Layout
# This cop checks the indentation of comments.
# Checks the indentation of comments.
#
# @example
# # bad
Expand Down
2 changes: 1 addition & 1 deletion lib/rubocop/cop/layout/condition_position.rb
Expand Up @@ -3,7 +3,7 @@
module RuboCop
module Cop
module Layout
# This cop checks for conditions that are not on the same line as
# Checks for conditions that are not on the same line as
# if/while/until.
#
# @example
Expand Down
2 changes: 1 addition & 1 deletion lib/rubocop/cop/layout/def_end_alignment.rb
Expand Up @@ -3,7 +3,7 @@
module RuboCop
module Cop
module Layout
# This cop checks whether the end keywords of method definitions are
# Checks whether the end keywords of method definitions are
# aligned properly.
#
# Two modes are supported through the EnforcedStyleAlignWith configuration
Expand Down
2 changes: 1 addition & 1 deletion lib/rubocop/cop/layout/dot_position.rb
Expand Up @@ -3,7 +3,7 @@
module RuboCop
module Cop
module Layout
# This cop checks the . position in multi-line method calls.
# Checks the . position in multi-line method calls.
#
# @example EnforcedStyle: leading (default)
# # bad
Expand Down
2 changes: 1 addition & 1 deletion lib/rubocop/cop/layout/else_alignment.rb
Expand Up @@ -3,7 +3,7 @@
module RuboCop
module Cop
module Layout
# This cop checks the alignment of else keywords. Normally they should
# Checks the alignment of else keywords. Normally they should
# be aligned with an if/unless/while/until/begin/def/rescue keyword, but there
# are special cases when they should follow the same rules as the
# alignment of end.
Expand Down
2 changes: 1 addition & 1 deletion lib/rubocop/cop/layout/empty_comment.rb
Expand Up @@ -3,7 +3,7 @@
module RuboCop
module Cop
module Layout
# This cop checks empty comment.
# Checks empty comment.
#
# @example
# # bad
Expand Down
2 changes: 1 addition & 1 deletion lib/rubocop/cop/layout/empty_line_after_guard_clause.rb
Expand Up @@ -3,7 +3,7 @@
module RuboCop
module Cop
module Layout
# This cop enforces empty line after guard clause
# Enforces empty line after guard clause
#
# @example
#
Expand Down
Expand Up @@ -3,7 +3,7 @@
module RuboCop
module Cop
module Layout
# This cop enforces empty line after multiline condition.
# Enforces empty line after multiline condition.
#
# @example
# # bad
Expand Down
2 changes: 1 addition & 1 deletion lib/rubocop/cop/layout/empty_line_between_defs.rb
Expand Up @@ -3,7 +3,7 @@
module RuboCop
module Cop
module Layout
# This cop checks whether class/module/method definitions are
# Checks whether class/module/method definitions are
# separated by one or more empty lines.
#
# `NumberOfEmptyLines` can be an integer (default is 1) or
Expand Down
2 changes: 1 addition & 1 deletion lib/rubocop/cop/layout/empty_lines.rb
Expand Up @@ -3,7 +3,7 @@
module RuboCop
module Cop
module Layout
# This cop checks for two or more consecutive blank lines.
# Checks for two or more consecutive blank lines.
#
# @example
#
Expand Down
2 changes: 1 addition & 1 deletion lib/rubocop/cop/layout/empty_lines_around_arguments.rb
Expand Up @@ -3,7 +3,7 @@
module RuboCop
module Cop
module Layout
# This cop checks if empty lines exist around the arguments
# Checks if empty lines exist around the arguments
# of a method invocation.
#
# @example
Expand Down
2 changes: 1 addition & 1 deletion lib/rubocop/cop/layout/empty_lines_around_begin_body.rb
Expand Up @@ -3,7 +3,7 @@
module RuboCop
module Cop
module Layout
# This cop checks if empty lines exist around the bodies of begin-end
# Checks if empty lines exist around the bodies of begin-end
# blocks.
#
# @example
Expand Down
2 changes: 1 addition & 1 deletion lib/rubocop/cop/layout/empty_lines_around_block_body.rb
Expand Up @@ -3,7 +3,7 @@
module RuboCop
module Cop
module Layout
# This cop checks if empty lines around the bodies of blocks match
# Checks if empty lines around the bodies of blocks match
# the configuration.
#
# @example EnforcedStyle: empty_lines
Expand Down
2 changes: 1 addition & 1 deletion lib/rubocop/cop/layout/empty_lines_around_class_body.rb
Expand Up @@ -3,7 +3,7 @@
module RuboCop
module Cop
module Layout
# This cop checks if empty lines around the bodies of classes match
# Checks if empty lines around the bodies of classes match
# the configuration.
#
# @example EnforcedStyle: empty_lines
Expand Down
Expand Up @@ -3,7 +3,7 @@
module RuboCop
module Cop
module Layout
# This cop checks if empty lines exist around the bodies of `begin`
# Checks if empty lines exist around the bodies of `begin`
# sections. This cop doesn't check empty lines at `begin` body
# beginning/end and around method definition body.
# `Style/EmptyLinesAroundBeginBody` or `Style/EmptyLinesAroundMethodBody`
Expand Down
2 changes: 1 addition & 1 deletion lib/rubocop/cop/layout/empty_lines_around_method_body.rb
Expand Up @@ -3,7 +3,7 @@
module RuboCop
module Cop
module Layout
# This cop checks if empty lines exist around the bodies of methods.
# Checks if empty lines exist around the bodies of methods.
#
# @example
#
Expand Down
2 changes: 1 addition & 1 deletion lib/rubocop/cop/layout/empty_lines_around_module_body.rb
Expand Up @@ -3,7 +3,7 @@
module RuboCop
module Cop
module Layout
# This cop checks if empty lines around the bodies of modules match
# Checks if empty lines around the bodies of modules match
# the configuration.
#
# @example EnforcedStyle: empty_lines
Expand Down
2 changes: 1 addition & 1 deletion lib/rubocop/cop/layout/end_alignment.rb
Expand Up @@ -3,7 +3,7 @@
module RuboCop
module Cop
module Layout
# This cop checks whether the end keywords are aligned properly.
# Checks whether the end keywords are aligned properly.
#
# Three modes are supported through the `EnforcedStyleAlignWith`
# configuration parameter:
Expand Down
2 changes: 1 addition & 1 deletion lib/rubocop/cop/layout/end_of_line.rb
Expand Up @@ -3,7 +3,7 @@
module RuboCop
module Cop
module Layout
# This cop checks for Windows-style line endings in the source code.
# Checks for Windows-style line endings in the source code.
#
# @example EnforcedStyle: native (default)
# # The `native` style means that CR+LF (Carriage Return + Line Feed) is
Expand Down
2 changes: 1 addition & 1 deletion lib/rubocop/cop/layout/extra_spacing.rb
Expand Up @@ -3,7 +3,7 @@
module RuboCop
module Cop
module Layout
# This cop checks for extra/unnecessary whitespace.
# Checks for extra/unnecessary whitespace.
#
# @example
#
Expand Down
2 changes: 1 addition & 1 deletion lib/rubocop/cop/layout/first_argument_indentation.rb
Expand Up @@ -3,7 +3,7 @@
module RuboCop
module Cop
module Layout
# This cop checks the indentation of the first argument in a method call.
# Checks the indentation of the first argument in a method call.
# Arguments after the first one are checked by `Layout/ArgumentAlignment`,
# not by this cop.
#
Expand Down
2 changes: 1 addition & 1 deletion lib/rubocop/cop/layout/first_array_element_indentation.rb
Expand Up @@ -3,7 +3,7 @@
module RuboCop
module Cop
module Layout
# This cop checks the indentation of the first element in an array literal
# Checks the indentation of the first element in an array literal
# where the opening bracket and the first element are on separate lines.
# The other elements' indentations are handled by the ArrayAlignment cop.
#
Expand Down
2 changes: 1 addition & 1 deletion lib/rubocop/cop/layout/first_array_element_line_break.rb
Expand Up @@ -3,7 +3,7 @@
module RuboCop
module Cop
module Layout
# This cop checks for a line break before the first element in a
# Checks for a line break before the first element in a
# multi-line array.
#
# @example
Expand Down
2 changes: 1 addition & 1 deletion lib/rubocop/cop/layout/first_hash_element_indentation.rb
Expand Up @@ -3,7 +3,7 @@
module RuboCop
module Cop
module Layout
# This cop checks the indentation of the first key in a hash literal
# Checks the indentation of the first key in a hash literal
# where the opening brace and the first key are on separate lines. The
# other keys' indentations are handled by the HashAlignment cop.
#
Expand Down
2 changes: 1 addition & 1 deletion lib/rubocop/cop/layout/first_hash_element_line_break.rb
Expand Up @@ -3,7 +3,7 @@
module RuboCop
module Cop
module Layout
# This cop checks for a line break before the first element in a
# Checks for a line break before the first element in a
# multi-line hash.
#
# @example
Expand Down
2 changes: 1 addition & 1 deletion lib/rubocop/cop/layout/first_method_argument_line_break.rb
Expand Up @@ -3,7 +3,7 @@
module RuboCop
module Cop
module Layout
# This cop checks for a line break before the first argument in a
# Checks for a line break before the first argument in a
# multi-line method call.
#
# @example
Expand Down
Expand Up @@ -3,7 +3,7 @@
module RuboCop
module Cop
module Layout
# This cop checks for a line break before the first parameter in a
# Checks for a line break before the first parameter in a
# multi-line method parameter definition.
#
# @example
Expand Down
2 changes: 1 addition & 1 deletion lib/rubocop/cop/layout/first_parameter_indentation.rb
Expand Up @@ -3,7 +3,7 @@
module RuboCop
module Cop
module Layout
# This cop checks the indentation of the first parameter in a method
# Checks the indentation of the first parameter in a method
# definition. Parameters after the first one are checked by
# Layout/ParameterAlignment, not by this cop.
#
Expand Down
Expand Up @@ -3,7 +3,7 @@
module RuboCop
module Cop
module Layout
# This cop checks for the placement of the closing parenthesis
# Checks for the placement of the closing parenthesis
# in a method call that passes a HEREDOC string as an argument.
# It should be placed at the end of the line containing the
# opening HEREDOC tag.
Expand Down
2 changes: 1 addition & 1 deletion lib/rubocop/cop/layout/heredoc_indentation.rb
Expand Up @@ -3,7 +3,7 @@
module RuboCop
module Cop
module Layout
# This cop checks the indentation of the here document bodies. The bodies
# Checks the indentation of the here document bodies. The bodies
# are indented one step.
#
# Note: When ``Layout/LineLength``'s `AllowHeredoc` is false (not default),
Expand Down
2 changes: 1 addition & 1 deletion lib/rubocop/cop/layout/indentation_consistency.rb
Expand Up @@ -3,7 +3,7 @@
module RuboCop
module Cop
module Layout
# This cop checks for inconsistent indentation.
# Checks for inconsistent indentation.
#
# The difference between `indented_internal_methods` and `normal` is
# that the `indented_internal_methods` style prescribes that in
Expand Down

0 comments on commit 133ffce

Please sign in to comment.