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

Add support for methods defined with define_singleton_method #2

Open
uvlad7 opened this issue Nov 6, 2023 · 1 comment
Open

Add support for methods defined with define_singleton_method #2

uvlad7 opened this issue Nov 6, 2023 · 1 comment
Labels
good first issue Good for newcomers help wanted Extra attention is needed

Comments

@uvlad7
Copy link

uvlad7 commented Nov 6, 2023

So, I don't have any Rust struct to wrap, I just make a Ruby binding for a third-party crate. So, the methods are defined with define_singleton_method, and yard-rustdoc doesn't seem to work with them.

I ended up doing this, it's fine for this specific gem, but I actually want to use a more clean solution - like rustdoc - for docs, because I want this project to become a template of wrapping a Rust library into a Ruby/Jruby gem, a Python package, etc.

Btw documenting modules/classes created with define_module/define_class would be nice, too.

@ianks ianks changed the title Help needed - how to document methods registered via define_singleton_method Add support for methods defined with define_singleton_method Nov 29, 2023
@ianks ianks added good first issue Good for newcomers help wanted Extra attention is needed labels Nov 29, 2023
@ianks
Copy link

ianks commented Nov 29, 2023

Hey @uvlad7 thanks for the report! There's definitely some gaps with the plugin that we would love some help with. Thanks for reporting this. Turning this into an issue for someone to pick up

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

2 participants