cable_ready Write YARD docs for public API

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

Jan 19 '21 07:01 julianrubisch

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?

Jan 19 '21 17:01 leastbad

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

Jan 19 '21 18:01 julianrubisch

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

Jan 19 '21 18:01 marcoroth

That’s one of my intended side effects, yep

Jan 19 '21 18:01 julianrubisch

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!

Jan 19 '21 18:01 leastbad

YARD + Solargraph = *chef's kiss*

Jun 10 '21 17:06 jaredcwhite

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? 😬

Feb 15 '23 07:02 julianrubisch