Commit 66cbd651 by Jon Frisby

Update docs.

parent 75904357
......@@ -10,7 +10,7 @@
'# -*- SkipSchemaAnnotations' anywhere in the file.
* Don't show column limits for integer and boolean types.
* Add sorting for columns and indexes. (Helpful for out-of-order migration
execution!)
execution, but use --no-sort if you don't want this.)
* Annotate unit tests in subfolders.
* Add generator to install rakefile that automatically annotates on db:migrate.
* Correct Gemfile to clarify which environments need which gems.
......
......@@ -76,6 +76,10 @@ To annotate routes.rb:
annotate_models -r
To remove annotations:
annotate_models -d
To automatically annotate after running 'rake db:migrate', ensure you've added
annotate_models to your Rails project's Gemfile, and run this:
......@@ -105,6 +109,14 @@ anywhere in the file:
-R, --require path Additional files to require before loading models
-e [tests,fixtures] Do not annotate fixtures/factories, and/or test files
--exclude
-n --no-sort Sort by column creation order rather than alphabetical order
== SORTING
By default, columns will be sorted alphabetically so that the results of
annotation are consistent regardless of what order migrations are executed in.
If you prefer the old behavior, use --no-sort.
== WARNING
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment