We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
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
@!scope class
Docs here states that this should mark method1 & method2 as class methods:
method1
method2
# @!scope class # Documentation for method1 def method1; end # Documentation for method2 def method2; end
In my experience, this doesn't work and @!scope class must be repeated on all methods definitions
Repro:
class Test def test_instance; end # @!scope class # method1 doc def method1; end # method2 doc def method2; end end class Test2 def test_instance; end # @!scope class def method1; end def method2; end end class Test3 def test_instance; end # method1 doc # @!scope class def method1; end # method2 doc # @!scope class def method2; end end
I would expect Test & Test2 to behave the same, with Test2 methods having no doc.
Test
Test2
I would expect Test & Test2 to have method1 & method2 as class methods.
I would expect Test & Test3 to have the same doc.
Test3
ruby -v
yard -v
I have read the Contributing Guide.
The text was updated successfully, but these errors were encountered:
a4f0fcc
Thanks for the report! This is fixed in the above commit and will be in the next release.
Sorry, something went wrong.
No branches or pull requests
Docs here states that this should mark
method1
&method2
as class methods:In my experience, this doesn't work and
@!scope class
must be repeated on all methods definitionsSteps to reproduce
Repro:
Actual Output
Expected Output
I would expect
Test
&Test2
to behave the same, withTest2
methods having no doc.I would expect
Test
&Test2
to havemethod1
&method2
as class methods.I would expect
Test
&Test3
to have the same doc.Environment details:
ruby -v
): ruby 3.0.2p107 (2021-07-07 revision 0db68f0233) [x86_64-linux]yard -v
): yard 0.9.26I have read the Contributing Guide.
The text was updated successfully, but these errors were encountered: