tribusonz-2 / rb_wave

Wave library for Ruby
MIT License
0 stars 0 forks source link

RDoc vs. YARD - Which one will be chosen? #6

Open tribusonz-2 opened 2 months ago

tribusonz-2 commented 2 months ago

Matz asked us to implement the PCM class and merge it into Ruby, but it has taken quite a while. First of all, the fact that it is a small-framework is close to the barrier. There are also some libraries that should be implemented in the core classes. (Implementing IO::Buffer is a gift!)

When creating a framework, everything is determined by the design of the basic constructor. (Caution:) Redesigning a constructor would be like demolition and rebuilding a building, requiring unnecessary effort. That's why everything is determined by the first design.

Also, for small framework extension libraries, is RDoc or YARD the preferred choice for documentation? Our development was progressing with RDoc, but there are limits. I feel that choosing YARD is appropriate.