Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Splat parameter without name is discarded in documentation signature #1265

Open
AaronC81 opened this issue Jul 24, 2019 · 0 comments
Open

Splat parameter without name is discarded in documentation signature #1265

AaronC81 opened this issue Jul 24, 2019 · 0 comments

Comments

@AaronC81
Copy link

If * is used as an argument inside a method signature, this argument is not shown in the generated documentation. This is causing this issue in one of my projects.

Steps to reproduce

Generate YARD documentation for this code:

class A
  def x(a, b, *); end
end

Actual Output

image

Expected Output

The method signature in the documentation should be #x(a, b, *) => Object.

Environment details:

  • OS: Ubuntu 18.04
  • Ruby version (ruby -v): ruby 2.5.1p57 (2018-03-29 revision 63029) [x86_64-linux-gnu]
  • YARD version (yard -v): yard 0.9.20

I have read the Contributing Guide.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant