search

smashingboxes / box_cutter

Box Cutter is inspired by thoughtbot's Suspenders. Just like Suspenders says, use Box Cutter if you're in a rush to build something amazing; don't use it if you like missing deadlines.
MIT License
4 stars 2 forks source link

Annotate? #5

Open leonelgalan opened 10 years ago

leonelgalan commented 10 years ago

Using https://github.com/ctran/annotate_models, my only complain about it was that comments get outdated but apparently when migrating and not running annotate, but we can get it to do it automatically installing it: rails g annotate:install

I still added the issue, so we can discuss if this is the best option or if anyone knows about another.

reedlaw commented 10 years ago

I'm in favor :thumbsup:

RickCarlino commented 10 years ago

I haven't been a fan of this one. It's the same info you can find in your schema.rb. More than anything I felt like it just gets in the way in larger models and makes it harder to find real documentation (eg: why does this model exist? What problem does it solve? What things should you be aware of that are not aparent?)

LNauman commented 10 years ago

I agree with @rickcarlino I don't see a benefit because everything is in the schema.rb already.

joeyjoejoejr commented 10 years ago

Yeah, I've never found it all that useful. I think there is an option you can set that will put the annotation at the bottom of the model, I'd be fine with that.

elfassy commented 10 years ago

There is such option (to put it at the bottom) . I vote for having it. It's useful when it's not your own code you are looking at. Also there's no downside. On Aug 8, 2014 10:36 AM, "Joe Jackson" notifications@github.com wrote:

Yeah, I've never found it all that useful. I think there is an option you can set that will put the annotation at the bottom of the model, I'd be fine with that.

— Reply to this email directly or view it on GitHub https://github.com/smashingboxes/box_cutter/issues/5#issuecomment-51610201 .