RubyFlow The Ruby and Rails community linklog


The Ruby and Rails community linklog

Made a library? Written a blog post? Found a useful tutorial? Share it with the Ruby community here or just enjoy what everyone else has found!

Add extra documentation to your tables columns with built-in comments

Hey folks, I just wrote a quick TIL on how to add extra documentation to your models attributes.

I’ve found Yard doc to be neat for public methods, but sometimes, models attributes are not super well documented. I recently had the case where we had several duration attributes spread across several models, and each duration had its own unit. But nowhere was it documented.

Post a comment

You can use basic HTML markup (e.g. <a>) or Markdown.

As you are not logged in, you will be
directed via GitHub to signup or sign in