Warnings in yard doc generation

[d4rk5eed]

Got some warnings in yard doc

[warn]: Invalid tag format for @example in file `lib/rubocop/cop/corrector.rb` near line 33
[warn]: Invalid tag format for @example in file `lib/rubocop/cop/style/module_function.rb` near line 15
[warn]: Invalid tag format for @example in file `lib/rubocop/cop/style/indentation_width.rb` near line 15
[warn]: Invalid tag format for @example in file `lib/rubocop/cop/lint/require_parentheses.rb` near line 20
[warn]: Invalid tag format for @example in file `lib/rubocop/cop/style/indentation_consistency.rb` near line 16
[warn]: Invalid tag format for @example in file `lib/rubocop/cop/style/method_called_on_do_end_block.rb` near line 15
[warn]: Invalid tag format for @example in file `lib/rubocop/cop/lint/parentheses_as_grouped_expression.rb` near line 12

Shoud it be corrected?

[bbatsov]

Sure.

On 24 January 2015 at 16:16, d4rk5eed notifications@github.com wrote:

Got some warnings in yard doc

[warn]: Invalid tag format for @example in file lib/rubocop/cop/corrector.rb near line 33
[warn]: Invalid tag format for @example in file lib/rubocop/cop/style/module_function.rb near line 15
[warn]: Invalid tag format for @example in file lib/rubocop/cop/style/indentation_width.rb near line 15
[warn]: Invalid tag format for @example in file lib/rubocop/cop/lint/require_parentheses.rb near line 20
[warn]: Invalid tag format for @example in file lib/rubocop/cop/style/indentation_consistency.rb near line 16
[warn]: Invalid tag format for @example in file lib/rubocop/cop/style/method_called_on_do_end_block.rb near line 15
[warn]: Invalid tag format for @example in file lib/rubocop/cop/lint/parentheses_as_grouped_expression.rb near line 12

Shoud it be corrected?

—
Reply to this email directly or view it on GitHub
#1594.

[mattjmcnaughton]

I can fix this unless anyone else wants to! It's just a problem with those examples not being properly indented.