sord VS yard-doctest

I tend to follow along using the YardDoc comment style. It has many small things I love about it; an example is when yardoc is followed it can be used to generate RBS/Sorbet type files with the sord gem, you can also generate application documents similar to rdoc/sdoc.

You may be interesting in checking out the Sord gem. If you do YARDOC based comments and documentation in your code not only does it make your code pretty easy to understand. But you can also generate Sorbet RBI and Ruby RBS files based off of your documentation. It's pretty much a require in any new project I start working with.

I love using yard as well and if you use it you can use sord and based on you yard annotates it'll build sorbet types for your code. I've used it on my last few projects and it's helped building your types setup amazingly easy.

Sord was originally developed to generate Sorbet type signature files from YARD comments. Sorbet is a type checking system developed by Stripe, and it does not use anything specific to Ruby 3 but is instead a custom DSL for defining types. However, Sord has recently been upgraded to support generation of RBS files (Ru*by **Signature*). This means that instead of having to write all your Ruby 3 type signature files by hand (which are standalone—Ruby 3 doesn't support inline typing in Ruby code itself), you can write YARD comments—just like with Solargraph—and autogenerate the signature files.

Why isn't anyone talking about Sord?? I see that as being a great solution. https://github.com/AaronC81/sord#example

Go for both until things evolve : https://github.com/AaronC81/sord

I never used these, but is it like Python's doctests? If so it exists for YARD: https://github.com/p0deje/yard-doctest