public
Description: Annotate ActiveRecord models as a gem
Homepage: http://agilewebdevelopment.com/plugins/annotate_models
Clone URL: git://github.com/ctran/annotate_models.git
commit  b1ab589f7bd5af459978567edb0e1489b7b794af
tree    9566e6afcbe37277ff818435517242d038579ebe
parent  7f96c0c88868afc2b80fe4b4c8748a5edad27c29
annotate_models / README.txt
100644 47 lines (30 sloc) 1.05 kb
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
== AnnotateModels
 
Add a comment summarizing the current schema to the top of each ActiveRecord model source file.
 
  # Schema as of Sun Feb 26 21:58:32 CST 2006 (schema version 7)
  #
  # id :integer(11) not null
  # quantity :integer(11)
  # product_id :integer(11)
  # unit_price :float
  # order_id :integer(11)
  #
 
  class LineItem < ActiveRecord::Base
    belongs_to :product
  
   end
  
Note that this code will blow away the initial comment block in your models if it looks like it was
previously added by annotate models, so you don't want to add additional text to an automatically
created comment block.
 
== Install
 
  sudo gem install sake annotate_models
  
== Usage
 
  cd [your project]
  annotate
 
== Source
 
  http://github.com/ctran/annotate_models
  
  
== Author
   Dave Thomas
   Pragmatic Programmers, LLC
 
Released under the same license as Ruby. No Support. No Warranty.
 
 
== Modifications
 - alex@pivotallabs.com
 - ctran@pragmaquest.com