Code comment documentation format
skull-squadron opened this issue · 1 comments
skull-squadron commented
What is it using? It looks like some sort of Java or TS doc format rather than yard or rdoc, and there's apparent no mention of it.
I'm wondering why yard wasn't used because there's yard2steep and sord.
fxn commented
Good point. It is RBS syntax and that is now documented in PROJECT_RULES.md.
These annotations are not meant for public consumption, it is internal documentation. The signature of the public interface is documented in the README in English when it matters.