Improve adding missing @param

[bogdan]

Params order

YARD/MismatchName cop adds a missing @param at the bottom of the doc.
It is better if it could add it to the place where other @param is defined.

it would be cool to have an DirectivesOrder cop that puts all directives to the specified order all the time including ordering the @param as they appear in method signature.

Default param type

It would be also good to better guess the type of the added parameter from its default value:

# @param [Boolean] html
# instead of
# @param [Object] html
def columns(html: false)
end

Thanks for all the hard work!

[ksss]

@bogdan Thank you for your feedback.
I implemented to guess type from default value. And v0.10.0 has been released.

The DirectivesOrder seems difficult to implement. If there is a patch, I would like to merge it.

[aaronmallen]

Additionally this will cause a YARD/MismatchName error as well and shouldn't:

# Some method that does things
# 
# @param some_arg [String]
# @param some_other_arg [String]
# @param options [Hash]
#
# @return [void]
def some_method(...)
   some_method_that_excepts_two_args_and_splat_hash(...)
end

I'm unsure if this should be a separate issue or if this is fine here... @ksss if you want me to create a separate issue for it I'd be happy to.

[aaronmallen]

Hmmm looking into this further this might be an issue with YARD itself as yard ALSO seems to ignore the docs for the forwarded params. It looks like you can use @overload to get around it.

[ksss]

@aaronmallen Thank you for your report.
If there is any inconvenience, please write a new issue.

[aaronmallen]

@aaronmallen Thank you for your report.
If there is any inconvenience, please write a new issue.

I don't think it's a bug with the plugin. It was another misunderstanding of Yard expectations. You essentially need to call @overload for argument forwarding it would appear.