Skip to content

Rdoc does not correctly recognise params that have the splat operator #321

@tomkadwill

Description

@tomkadwill
# Takes one parameter, +param+
def my_method(*param)

In this example rdoc will not recognise that param and *param are the same thing. If I generate a coverage report the method will still be flagged as having an undocumented parameter.

If I write the documentation as shown below then it will pass the coverage report.

# Takes one parameter, +*param+
def my_method(*param)

However, I would have thought the documentation in the first example is better?

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions