Write YARD docs for public API

[julianrubisch]

This would help with code intellisense tool such as Language Servers (Solargraph)

[leastbad]

I don't know anything about YARD. How would we get from A to B? Is there an automated process or would someone have to convert everything to a new format?

[julianrubisch]

Annotated source code... I started a bit exemplary docs in #100

[marcoroth]

We should probably make sure it's compatible with sord for example so we also get RBS annotations for free! 😊

[julianrubisch]

That’s one of my intended side effects, yep

[leastbad]

OH, I had no idea that the structure and format of those comments was significant.

Yeah, this doesn't seem painful at all. Good call, Julian!

[jaredcwhite]

YARD + Solargraph = *chef's kiss*

[julianrubisch]

I still think this could be of value, and should be a good practice for writing libraries in general.

The problem is tooling - does anyone know of something that helps me remember the YARD syntax? 😬