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

see for params doesn't seem to be picked up by solargraph #696

Open
renatolond opened this issue Nov 9, 2023 · 1 comment
Open

see for params doesn't seem to be picked up by solargraph #696

renatolond opened this issue Nov 9, 2023 · 1 comment

Comments

@renatolond
Copy link

renatolond commented Nov 9, 2023

With this class

class FooBar
  # @param param [String] My Cool Param
  def method1(param); end

  # @param param (see #method1)
  def method2(param); end
end

(I realize in the screenshots it's showing the name param1, but I fixed it and the result is the same)

If I generate the yard docs, method2 gets the params described:
image

However, it seems that solargraph does not pick up the param for method2:
image
While it picks up for method1:
image

It seems using the see for all params also does not work

class FooBar
  # @param param1 [String] My Cool Param
  def method1(param); end

  # @param (see #method1)
  def method2(param); end
end

Solargraph version:

❯ solargraph -v
0.49.0
@castwide
Copy link
Owner

castwide commented Dec 7, 2023

The (see x) syntax isn't currently supported in Solargraph, but it's useful enough that I'll try to get it into the next release.

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

No branches or pull requests

2 participants