bitcoin-ruby icon indicating copy to clipboard operation
bitcoin-ruby copied to clipboard
verified publisher icon lian

Enrich and standardize documents.

Open kannapoix opened this issue 7 years ago • 1 comments

README says

Documentation is generated using yardoc

but I sees RDoc like sysntax, like +tx+. Also there many methods which has no document and no description and class info about a parameter. Now you are revamping this repository, so I think this is good time to enrich and standardize documents. YARD or RDoc?

Any thoughts?

kannapoix avatar Aug 27 '18 16:08 kannapoix

Feel free to contribute if this is important to you :) Otherwise, we will get to this as we have time.

etscrivner avatar Aug 27 '18 16:08 etscrivner