Change ExampleTag description to use @example

dkubb · Oct 26, 2015 · d488fc6 · d488fc6
1 parent 097ea65
commit d488fc6
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 4 deletions.
diff --git a/lib/yardstick/rules/example_tag.rb b/lib/yardstick/rules/example_tag.rb
@@ -7,7 +7,7 @@ module Rules
     # This applies only for public methods
     #
     class ExampleTag < Rule
-      self.description = 'The public/semipublic method should have an example specified'.freeze
+      self.description = 'The public/semipublic method should have an @example specified'.freeze
 
       # @see class description
       #

diff --git a/spec/integration/yardstick/processor/process_string_spec.rb b/spec/integration/yardstick/processor/process_string_spec.rb
@@ -174,7 +174,7 @@ def test(value)
     it { should be_kind_of(Yardstick::MeasurementSet) }
 
     it 'has a correct measurement' do
-      expect(measurement('The public/semipublic method should have an example specified'))
+      expect(measurement('The public/semipublic method should have an @example specified'))
         .to be_ok
     end
   end
@@ -191,7 +191,7 @@ def test(value)
     it { should be_kind_of(Yardstick::MeasurementSet) }
 
     it 'is skipped' do
-      expect(measurement('The public/semipublic method should have an example specified'))
+      expect(measurement('The public/semipublic method should have an @example specified'))
         .to be_skip
     end
   end
@@ -210,7 +210,7 @@ def test(value)
     it { should be_kind_of(Yardstick::MeasurementSet) }
 
     it 'is skipped' do
-      expect(measurement('The public/semipublic method should have an example specified'))
+      expect(measurement('The public/semipublic method should have an @example specified'))
         .to be_skip
     end
   end