Paweł ŚwiątkowskiAug 5, 2023
What are some gems with excellent YARD docs, that can be used as a reference?
Show threadpostmodernAug 5, 2023

@katafrakt depends on what you mean by excellent YARD docs. I would recommend:

* command_kit (https://rubydoc.info/gems/command_kit)
* spidr (https://rubydoc.info/gems/spidr)
* Ronin gems (https://ronin-rb.dev/docs/#api)
* most of my gems since I always use YARD and try to get >80% doc coverage.
#YARD #yardoc

File: README — Documentation for command_kit (0.4.0)

Show threadPaweł Świątkowski

@postmodern I don't know exactly what I mean, but I'm looking for gems that use YARD for more than just one-liner three-words description of every method. I want to slowly start testing my YARD template with some real-life examples.

Thanks for these suggestions, they look very useful!

Aug 6, 2023 at 1:46pmWeb
Show threadpostmodernAug 8, 2023
@katafrakt I am curious to see how your YARD template turns out. I've thought about making my own YARD template for a big project that includes a dark-mode switch or custom color scheme, but it seems like a ton of work just to change a few things.