search

AaronC81 / sord

Convert YARD docs to Sorbet RBI and Ruby 3/Steep RBS files
https://sord.aaronc.cc
MIT License
304 stars 18 forks source link

Don't output documentation when rerunning YARD #157

Closed dorner closed 2 years ago

dorner commented 2 years ago

Regenerating YARD is only useful for sord in that it parses the source files and outputs the yardoc database. The actual HTML files are of no purpose. This updates the yard command so that HTML files are not output. This makes sord much, much faster even when regenerating documentation.

We can decide if we want to put this behind a setting or not - it is a breaking change, but I don't really see any point to the current behavior, and if anyone wants to actually generate documentation I think it makes more sense for them to run yard manually.

AaronC81 commented 2 years ago

Nice! I agree, Sord generating HTML docs previously was pretty much just a side effect - I'm happy without a setting for this.