Docs - formatting, etc
Greg Longtin <[email protected]> Sun, 17 Jul 2016 11:43:25 -0500
| Newsgroups | gmane.comp.lang.ruby.documentation |
|---|---|
| Message-ID | <[email protected]> |
To all, I've been working on a yard plug-in (yard-t2) that is basically an updated UX along with using XMLHttpRequest. I decided to work on its c parsing and get it to do a better job of generating docs for Ruby Core and Std-Lib. I've got several versions of Ruby doc'd -- https://msp-greg.github.io/Ruby-2.2/ https://msp-greg.github.io/Ruby-2.3/ https://msp-greg.github.io/Ruby-2.4/ Home page has UI info, etc https://msp-greg.github.io/ Anyway, end result is I've noticed several issues with the documentation; they affect both rdoc and yard-t2. One is the phrase 'For example:' in io.c causes several of ARGF's method docs to be formatted incorrectly. The lines simply need a space added. Other issues are tabs instead of spaces, indenting, missing call-seq: declarations, code samples that won't parse correctly, etc. Are pull requests for these kind of issues reviewed and accepted? Best way to submit them? Thanks, Greg