SciRuby / daru-io

daru-io is a plugin gem to the existing daru gem, which aims to add support to Importing DataFrames from / Exporting DataFrames to multiple formats.
http://www.rubydoc.info/github/athityakumar/daru-io/master/
MIT License
25 stars 9 forks source link

README & Markdown files #50

Closed athityakumar closed 7 years ago

athityakumar commented 7 years ago

Made the proposed changes. Please have a look. 😄

@zverok @v0dro - Also, from a user's perspective, I feel that YARD docs should first show information about the @param and @return before @example. But I've not been able to find a way of reordering these sections. Any insights regarding this?

zverok commented 7 years ago

But I've not been able to find a way of reordering these sections. Any insights regarding this?

I believe the only way is to make your own YARD templates, but I am not sure that rubydoc.info would respect them.