Skip to content
Browse files

documentation

  • Loading branch information...
1 parent 5b3d445 commit 952013efedbdd483a2e22ebe938789a16c86be24 @alexch alexch committed Oct 23, 2009
Showing with 25 additions and 42 deletions.
  1. +22 −41 README.rdoc
  2. +2 −1 lib/annotate/annotate_models.rb
  3. +1 −0 todo.txt
View
63 README.rdoc
@@ -27,12 +27,12 @@ The schema comment looks like this:
It also annotates geometrical columns, geom type and srid, when using SpatialAdapter or PostgisAdapter:
- # == Schema Info
- #
- # Table name: trips
- #
- # local :geometry point, 4326
- # path :geometry line_string, 4326
+ # == Schema Info
+ #
+ # Table name: trips
+ #
+ # local :geometry point, 4326
+ # path :geometry line_string, 4326
Also, if you pass the -r option, it'll annotate routes.rb with the output of "rake routes".
@@ -72,6 +72,11 @@ To automatically annotate after running 'rake db:migrate':
[needs more clarity] unpack the gem into vendor/plugins, or maybe vendor/gems, or maybe just require tasks/migrate.rake.
+If you install annotate_models as a plugin, it will automatically
+adjust your <tt>rake db:migrate</tt> tasks so that they update the
+annotations in your model files for you once the migration is
+completed.
+
== OPTIONS
Usage: annotate [options] [model_file]*
@@ -81,15 +86,11 @@ To automatically annotate after running 'rake db:migrate':
-v, --version Show the current version of this gem
-m, --show-migration Include the migration version number in the annotation
-i, --show-indexes List the table's database indexes in the annotation
+ -s, --simple-indexes Concat the column's related indexes in the annotation
--model-dir dir Annotate model files stored in dir rather than app/models
-R, --require path Additional files to require before loading models
-e, --exclude [tests,fixtures] Do not annotate fixtures, test files, or both
- If you install annotate_models as a plugin, it will automatically
- adjust your <tt>rake db:migrate</tt> tasks so that they update the
- annotations in your model files for you once the migration is
- completed.
-
== WARNING
@@ -111,29 +112,13 @@ to an automatically created comment block.
Released under the same license as Ruby. No Support. No Warranty.
-== Author:
-
-Original code by:
-
- Dave Thomas -- Pragmatic Programmers, LLC
-
-AnnotateModels mods by:
-
- Alexander Semyonov ( http://github.com/rotuka/annotate_models )
+== AUTHOR:
-AnnotateRoutes originally by:
+Original code by: Dave Thomas -- Pragmatic Programmers, LLC
+Overhauled by: Alex Chaffee
+Gemmed by: Cuong Tran
+Maintained by: Alex Chaffee and Cuong Tran
- Gavin Montague ( http://github.com/govan/annotate-routes )
-
-
-== Forked from:
-
- http://github.com/ctran/annotate_models
-
-
-== Modifications
- - alex@pivotallabs.com
-=======
Modifications by:
- Alex Chaffee - http://github.com/alexch - alex@pivotallabs.com
@@ -145,13 +130,9 @@ Modifications by:
- Neal Clark - http://github.com/nclark
- Jacqui Maher - http://github.com/jacqui
- Nick Plante - http://github.com/zapnap - http://blog.zerosum.org
-
+ - Pedro Visintin - http://github.com/peterpunk - http://www.pedrovisintin.com
+ - Bob Potter - http://github.com/bpot
+ - Gavin Montague - http://github.com/govan/
+ - Alexander Semyonov - http://github.com/rotuka/
+
and many others that I may have missed to add.
-
-<<<<<<< HEAD
-Primary maintainers: Cuong Tran and Alex Chaffee
-=======
-== This fork
-
- Marcos Piccinini ( http://github.com/nofxx/annotate )
->>>>>>> nofxx/master
View
3 lib/annotate/annotate_models.rb
@@ -273,7 +273,8 @@ def do_annotations(options={})
rescue Exception => e
puts "Unable to annotate #{file}: #{e.inspect}"
puts ""
- puts e.backtrace.join("\n\t")
+# todo: check if all backtrace lines are in "gems" -- if so, it's an annotate bug, so print the whole stack trace.
+# puts e.backtrace.join("\n\t")
end
end
if annotated.empty?
View
1 todo.txt
@@ -2,3 +2,4 @@ TODO
-----
change default position back to "top" for all
add "top" and "bottom" as synonyms for "before" and "after"
+change 'exclude' to 'only' (double negatives are not unconfusing)

0 comments on commit 952013e

Please sign in to comment.
Something went wrong with that request. Please try again.