Include @example tags in Pin::Method documentation

castwide / solargraph

A Ruby language server.

https://solargraph.org

MIT License

1.87k stars 154 forks source link

Include @example tags in Pin::Method documentation #718

Open lekemula opened 3 weeks ago

lekemula commented 3 weeks ago

When trying to add yardoc comments for some of RSpec DSL I noticed that @example tags are not being included. And for RSpec DSL those seem to be the most useful part. I believe examples are quite helpful in general for devs to see how a particular method is used.

Before:

image_1717952008834_0

After:

image_1717951339627_0