Should we adapt @generic tag as a YARD standard?

[lekemula]

Summary

Hi, this is a follow-up on #1606

While opening castwide/solargraph#1205, I was wondering whether it would make sense to adapt this as a YARD standard, rather than just a "LSP construct".

Problem statement

@generic would be a powerful means, primarily to the library developers, to offer clients a better DX via LSP completion/jump-to-definition.

Having it defined as a YARD standard would encourage a wider and quicker adoption of it which otherwise can be missed missed by gem devs who don't necessarily use the Solargraph LSP as their LSP of choice, or they simply don't use LSP at all.

Proposed solution

Adapt @generic as a YARD standard.

Alternatives considered

Keep it only documented on solargraph.org/guides/yard

Scope and impact

The more gems start using it, the better DX ruby devs (ie, clients) can have.

Additional context

Please refer to the examples on castwide/solargraph#1205 on the current @generic usage from the LSP perspective.

If you think this is a good idea, I'd be more than happy to draft a PR.

Thanks for your feedback in advance 🙏