Merge pull request #1367 from ydah/doc/header_comment

Fix cop header comment

docs/modules/ROOT/pages/cops_rspec.adoc

@@ -1993,16 +1993,15 @@ Checks for before/around/after hooks that come after an example.
 
 [source,ruby]
 ----
-# Bad
-
+# bad
 it 'checks what foo does' do
   expect(foo).to be
 end
 
 before { prepare }
 after { clean_up }
 
-# Good
+# good
 before { prepare }
 after { clean_up }
 
@@ -2432,28 +2431,28 @@ Enforce that subject is the first definition in the test.
 [source,ruby]
 ----
 # bad
-  let(:params) { blah }
-  subject { described_class.new(params) }
+let(:params) { blah }
+subject { described_class.new(params) }
 
-  before { do_something }
-  subject { described_class.new(params) }
+before { do_something }
+subject { described_class.new(params) }
 
-  it { expect_something }
-  subject { described_class.new(params) }
-  it { expect_something_else }
+it { expect_something }
+subject { described_class.new(params) }
+it { expect_something_else }
 
 # good
-  subject { described_class.new(params) }
-  let(:params) { blah }
+subject { described_class.new(params) }
+let(:params) { blah }
 
 # good
-  subject { described_class.new(params) }
-  before { do_something }
+subject { described_class.new(params) }
+before { do_something }
 
 # good
-  subject { described_class.new(params) }
-  it { expect_something }
-  it { expect_something_else }
+subject { described_class.new(params) }
+it { expect_something }
+it { expect_something_else }
 ----
 
 === References
@@ -2595,7 +2594,7 @@ Checks for `let` definitions that come after an example.
 
 [source,ruby]
 ----
-# Bad
+# bad
 let(:foo) { bar }
 
 it 'checks what foo does' do
@@ -2608,7 +2607,7 @@ it 'checks what some does' do
   expect(some).to be
 end
 
-# Good
+# good
 let(:foo) { bar }
 let(:some) { other }
 
@@ -2643,20 +2642,20 @@ Checks unreferenced `let!` calls being used for test setup.
 
 [source,ruby]
 ----
-# Bad
+# bad
 let!(:my_widget) { create(:widget) }
 
 it 'counts widgets' do
   expect(Widget.count).to eq(1)
 end
 
-# Good
+# good
 it 'counts widgets' do
   create(:widget)
   expect(Widget.count).to eq(1)
 end
 
-# Good
+# good
 before { create(:widget) }
 
 it 'counts widgets' do
@@ -2689,7 +2688,7 @@ Check that chains of messages are not being stubbed.
 # bad
 allow(foo).to receive_message_chain(:bar, :baz).and_return(42)
 
-# better
+# good
 thing = Thing.new(baz: 42)
 allow(foo).to receive(:bar).and_return(thing)
 ----
@@ -3294,7 +3293,7 @@ context 'when using some feature' do
   end
 end
 
-# better
+# good
 context 'using some feature as an admin' do
   let(:some)    { :various }
   let(:feature) { :setup   }

lib/rubocop/cop/rspec/align_left_let_brace.rb

@@ -6,16 +6,15 @@ module RSpec
       # Checks that left braces for adjacent single line lets are aligned.
       #
       # @example
+      #   # bad
+      #   let(:foobar) { blahblah }
+      #   let(:baz) { bar }
+      #   let(:a) { b }
       #
-      #     # bad
-      #     let(:foobar) { blahblah }
-      #     let(:baz) { bar }
-      #     let(:a) { b }
-      #
-      #     # good
-      #     let(:foobar) { blahblah }
-      #     let(:baz)    { bar }
-      #     let(:a)      { b }
+      #   # good
+      #   let(:foobar) { blahblah }
+      #   let(:baz)    { bar }
+      #   let(:a)      { b }
       #
       class AlignLeftLetBrace < Base
         extend AutoCorrector

lib/rubocop/cop/rspec/align_right_let_brace.rb

@@ -6,16 +6,15 @@ module RSpec
       # Checks that right braces for adjacent single line lets are aligned.
       #
       # @example
+      #   # bad
+      #   let(:foobar) { blahblah }
+      #   let(:baz)    { bar }
+      #   let(:a)      { b }
       #
-      #     # bad
-      #     let(:foobar) { blahblah }
-      #     let(:baz)    { bar }
-      #     let(:a)      { b }
-      #
-      #     # good
-      #     let(:foobar) { blahblah }
-      #     let(:baz)    { bar      }
-      #     let(:a)      { b        }
+      #   # good
+      #   let(:foobar) { blahblah }
+      #   let(:baz)    { bar      }
+      #   let(:a)      { b        }
       #
       class AlignRightLetBrace < Base
         extend AutoCorrector

lib/rubocop/cop/rspec/any_instance.rb

@@ -22,6 +22,7 @@ module RSpec
       #       allow(my_instance).to receive(:foo)
       #     end
       #   end
+      #
       class AnyInstance < Base
         MSG = 'Avoid stubbing using `%<method>s`.'
         RESTRICT_ON_SEND = %i[

lib/rubocop/cop/rspec/around_block.rb

@@ -25,6 +25,7 @@ module RSpec
       #     some_method
       #     test.run
       #   end
+      #
       class AroundBlock < Base
         MSG_NO_ARG     = 'Test object should be passed to around block.'
         MSG_UNUSED_ARG = 'You should call `%<arg>s.call` ' \

lib/rubocop/cop/rspec/be.rb

@@ -10,7 +10,6 @@ module RSpec
       # cases it's better to specify what exactly is the expected value.
       #
       # @example
-      #
       #   # bad
       #   expect(foo).to be
       #

lib/rubocop/cop/rspec/be_eq.rb

@@ -10,7 +10,6 @@ module RSpec
       # the `be` matcher is preferable as it is a more strict test.
       #
       # @example
-      #
       #   # bad
       #   expect(foo).to eq(true)
       #   expect(foo).to eq(false)

lib/rubocop/cop/rspec/be_eql.rb

@@ -11,7 +11,6 @@ module RSpec
       # preferable as it is a more strict test.
       #
       # @example
-      #
       #   # bad
       #   expect(foo).to eql(1)
       #   expect(foo).to eql(1.0)

lib/rubocop/cop/rspec/before_after_all.rb

@@ -23,6 +23,7 @@ module RSpec
       #     before(:each) { Widget.create }
       #     after(:each) { Widget.delete_all }
       #   end
+      #
       class BeforeAfterAll < Base
         MSG = 'Beware of using `%<hook>s` as it may cause state to leak ' \
               'between tests. If you are using `rspec-rails`, and ' \

lib/rubocop/cop/rspec/capybara/feature_methods.rb

@@ -40,6 +40,7 @@ module Capybara
         #       # ...
         #     end
         #   end
+        #
         class FeatureMethods < Base
           extend AutoCorrector
           include InsideExampleGroup

lib/rubocop/cop/rspec/capybara/visibility_matcher.rb

@@ -16,7 +16,6 @@ module Capybara
         # https://www.rubydoc.info/gems/capybara/Capybara%2FNode%2FFinders:all[the documentation].
         #
         # @example
-        #
         #   # bad
         #   expect(page).to have_selector('.foo', visible: false)
         #   expect(page).to have_css('.foo', visible: true)

lib/rubocop/cop/rspec/context_method.rb

@@ -23,6 +23,7 @@ module RSpec
       #   describe '.foo_bar' do
       #     # ...
       #   end
+      #
       class ContextMethod < Base
         extend AutoCorrector
 

lib/rubocop/cop/rspec/context_wording.rb

@@ -14,7 +14,6 @@ module RSpec
       # @see http://www.betterspecs.org/#contexts
       #
       # @example `Prefixes` configuration
-      #
       #   # .rubocop.yml
       #   # RSpec/ContextWording:
       #   #   Prefixes:
@@ -35,6 +34,7 @@ module RSpec
       #   context 'when the display name is not present' do
       #     # ...
       #   end
+      #
       class ContextWording < Base
         MSG = 'Start context description with %<prefixes>s.'
 

lib/rubocop/cop/rspec/describe_class.rb

@@ -10,7 +10,6 @@ module RSpec
       # Ignores Rails and Aruba `type` metadata by default.
       #
       # @example `IgnoredMetadata` configuration
-      #
       #   # .rubocop.yml
       #   # RSpec/DescribeClass:
       #   #   IgnoredMetadata:
@@ -34,6 +33,7 @@ module RSpec
       #
       #   describe "A feature example", type: :feature do
       #   end
+      #
       class DescribeClass < Base
         include TopLevelGroup
 

lib/rubocop/cop/rspec/describe_method.rb

@@ -16,6 +16,7 @@ module RSpec
       #
       #   describe MyClass, '.my_class_method' do
       #   end
+      #
       class DescribeMethod < Base
         include TopLevelGroup
 

lib/rubocop/cop/rspec/dialect.rb

@@ -41,6 +41,7 @@ module RSpec
       #   describe 'display name presence' do
       #     # ...
       #   end
+      #
       class Dialect < Base
         extend AutoCorrector
         include MethodPreference

lib/rubocop/cop/rspec/empty_example_group.rb

@@ -6,7 +6,6 @@ module RSpec
       # Checks if an example group does not include any tests.
       #
       # @example usage
-      #
       #   # bad
       #   describe Bacon do
       #     let(:bacon)      { Bacon.new(chunkiness) }
@@ -35,6 +34,7 @@ module RSpec
       #   describe Bacon do
       #     pending 'will add tests later'
       #   end
+      #
       class EmptyExampleGroup < Base
         extend AutoCorrector
 

lib/rubocop/cop/rspec/empty_hook.rb

@@ -22,6 +22,7 @@ module RSpec
       #     create_feed
       #   end
       #   after(:all) { cleanup_feed }
+      #
       class EmptyHook < Base
         extend AutoCorrector
         include RuboCop::Cop::RangeHelp

lib/rubocop/cop/rspec/empty_line_after_example.rb

@@ -30,7 +30,6 @@ module RSpec
       #   end
       #
       # @example with AllowConsecutiveOneLiners configuration
-      #
       #   # rubocop.yml
       #   # RSpec/EmptyLineAfterExample:
       #   #   AllowConsecutiveOneLiners: false

lib/rubocop/cop/rspec/empty_line_after_final_let.rb

@@ -16,6 +16,7 @@ module RSpec
       #   let(:something) { other }
       #
       #   it { does_something }
+      #
       class EmptyLineAfterFinalLet < Base
         extend AutoCorrector
         include EmptyLineSeparation

lib/rubocop/cop/rspec/empty_line_after_hook.rb

@@ -49,6 +49,7 @@ module RSpec
       #   after { do_something }
       #
       #   it { does_something }
+      #
       class EmptyLineAfterHook < Base
         extend AutoCorrector
         include ConfigurableEnforcedStyle

lib/rubocop/cop/rspec/empty_line_after_subject.rb

@@ -14,6 +14,7 @@ module RSpec
       #   subject(:obj) { described_class }
       #
       #   let(:foo) { bar }
+      #
       class EmptyLineAfterSubject < Base
         extend AutoCorrector
         include EmptyLineSeparation

lib/rubocop/cop/rspec/example_length.rb

@@ -47,6 +47,7 @@ module RSpec
       #       content.
       #     HEREDOC
       #   end                 # 5 points
+      #
       class ExampleLength < Base
         include CodeLength
 

lib/rubocop/cop/rspec/example_without_description.rb

@@ -47,6 +47,7 @@ module RSpec
       #     result = service.call
       #     expect(result).to be(true)
       #   end
+      #
       class ExampleWithoutDescription < Base
         include ConfigurableEnforcedStyle
 

lib/rubocop/cop/rspec/example_wording.rb

@@ -29,6 +29,7 @@ module RSpec
       #   # good
       #   it 'does things' do
       #   end
+      #
       class ExampleWording < Base
         extend AutoCorrector
 

lib/rubocop/cop/rspec/excessive_docstring_spacing.rb

@@ -22,6 +22,7 @@ module RSpec
       #   # good
       #   context 'when a condition is met' do
       #   end
+      #
       class ExcessiveDocstringSpacing < Base
         extend AutoCorrector
 

lib/rubocop/cop/rspec/expect_in_hook.rb

@@ -20,6 +20,7 @@ module RSpec
       #   it do
       #     expect(something).to eq 'foo'
       #   end
+      #
       class ExpectInHook < Base
         MSG = 'Do not use `%<expect>s` in `%<hook>s` hook'
 

lib/rubocop/cop/rspec/expect_output.rb

@@ -14,6 +14,7 @@ module RSpec
       #
       #   # good
       #   expect { my_app.print_report }.to output('Hello World').to_stdout
+      #
       class ExpectOutput < Base
         MSG = 'Use `expect { ... }.to output(...).to_%<name>s` ' \
               'instead of mutating $%<name>s.'