Incorrect Assessment for TomDoc

[fny]

Doc:

Converts the specified predicate method to a bang method. Beware: bang
methods will be created for undefined methods too. Assignment methods (`method=`)
and bang methods (`method!`) will not be converted.

klass - The Class to target for bangification
predicate_method - The Symbol of the predicate method
block - An optional block to run if a predicate method returns something falsey

Options

  matching - The Regexp used to match methods that should be bangified
  prefix - The String prefix to add to front of the bangified method
  suffix - The String suffix to add to end of the bangified method

Returns the Symbol name of the bang method created or nil if the method
was not bangified (ends in `!` or `=`.)

Method Signature: def bangify_method(klass, predicate_method, prefix: '', suffix: '')

Suggestions given:

• Describe what "bangify_method" returns.
• Describe the parameter "suffix".
• Describe the parameter "prefix".

---

Re: [B] Interrobang#bangify_method in fny/interrobang

[rrrene]

Thank you very much for the bug report! :+1:

I fixed the two parameters which where not detected correctly. As for the "Describe what the function returns" - this technically correct, as TomDoc requires you to indent the last line:

Lines SHOULD be wrapped at 80 columns. Wrapped lines MUST be indented, as a block, under the parent line by at least two spaces.

[fny]

Thanks for the tip. :)

On Mon, Apr 6, 2015 at 2:00 AM, René Föhring notifications@github.com wrote:

Thank you very much for the bug report! [image: :+1:]

I fixed the two parameters which where not detected correctly. As for the "Describe what the function returns" - this technically correct, as TomDoc requires you to indent the last line https://github.com/mojombo/tomdoc/blob/master/tomdoc.md#returns:

Lines SHOULD be wrapped at 80 columns. Wrapped lines MUST be indented, as a block, under the parent line by at least two spaces.

— Reply to this email directly or view it on GitHub https://github.com/inch-ci/inch_ci-web/issues/60#issuecomment-89937320.