Rails - May 2009 - DB field documentation suggestions wanted

Where do folks generally document their database attributes?

They appear as attributes (or methods) to the model.  Is there a way to
add pseudo methods so that rdoc picks them up along with their
documentation but they are not really defined in the ruby code?  Or do
people just add comments for the model class and document the fields
there?

Also, as I recall, somewhere there is a tool that will run and pull the
fields from the DB (or the migration?) and put them as comments in the
model.  Does that tool still exist?

Thank you,
Perry
-- 
Posted via http://www.ruby-forum.com/.

I think this is the tool you mean:

http://agilewebdevelopment.com/plugins/annotate_models


-----Original Message-----
From: rubyonrails-talk-/JYPxA39Uh5TLH3MbocFFw@public.gmane.org
[mailto:rubyonrails-talk@googlegroups.com] On Behalf Of Perry Smith
Sent: Wednesday, May 20, 2009 1:24 PM
To: rubyonrails-talk-/JYPxA39Uh5TLH3MbocFFw@public.gmane.org
Subject: [Rails] DB field documentation suggestions wanted


Where do folks generally document their database attributes?

They appear as attributes (or methods) to the model.  Is there a way to add
pseudo methods so that rdoc picks them up along with their documentation but
they are not really defined in the ruby code?  Or do people just add comments
for the model class and document the fields there?

Also, as I recall, somewhere there is a tool that will run and pull the fields
from the DB (or the migration?) and put them as comments in the model.  Does
that tool still exist?

Thank you,
Perry
--
Posted via http://www.ruby-forum.com/.



GHC Confidentiality Statement

This message and any attached files might contain confidential information
protected by federal and state law. The information is intended only for the use
of the individual(s) or entities originally named as addressees. The improper
disclosure of such information may be subject to civil or criminal penalties. If
this message reached you in error, please contact the sender and destroy this
message. Disclosing, copying, forwarding, or distributing the information by
unauthorized individuals or entities is strictly prohibited by law.

Roy Pardee wrote:
> I think this is the tool you mean:
> 
> http://agilewebdevelopment.com/plugins/annotate_models
Also take a look at HoboFields, which sort of does the same thing in 
reverse.  I''ve been experimenting with it and finding it pretty useful.
Basically, you define the fields right in the model file, and it writes 
migrations for you.

Best,
--
Marnen Laibow-Koser
http://www.marnen.org
marnen-sbuyVjPbboAdnm+yROfE0A@public.gmane.org
-- 
Posted via http://www.ruby-forum.com/.