Skip to content

Commit e32aae6

Browse files
committed
Update README to reflect serializer updates
1 parent 504c267 commit e32aae6

File tree

1 file changed

+9
-5
lines changed

1 file changed

+9
-5
lines changed

README.rdoc

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -86,13 +86,13 @@ To annotate just your models, tests, and factories:
8686

8787
To annotate just your models:
8888

89-
annotate --exclude tests,fixtures,factories
89+
annotate --exclude tests,fixtures,factories,serializers
9090

9191
To annotate routes.rb:
9292

9393
annotate --routes
9494

95-
To remove model/test/fixture/factory annotations:
95+
To remove model/test/fixture/factory/serializer annotations:
9696

9797
annotate --delete
9898

@@ -165,6 +165,8 @@ you can do so with a simple environment variable, instead of editing the
165165
Place the annotations at the top (before) or the bottom (after) of any test files
166166
--pr, --position-in-routes [before|after]
167167
Place the annotations at the top (before) or the bottom (after) of the routes.rb file
168+
--ps, --position-in-serializer [before|after]
169+
Place the annotations at the top (before) or the bottom (after) of the serializer files
168170
-r, --routes Annotate routes.rb with the output of 'rake routes'
169171
-v, --version Show the current version of this gem
170172
-m, --show-migration Include the migration version number in the annotation
@@ -174,13 +176,15 @@ you can do so with a simple environment variable, instead of editing the
174176
--ignore-model-subdirects Ignore subdirectories of the models directory
175177
--sort Sort columns alphabetically, rather than in creation order
176178
-R, --require path Additional file to require before loading models, may be used multiple times
177-
-e [tests,fixtures,factories], Do not annotate fixtures, test files, and/or factories
178-
--exclude
179+
-e [tests,fixtures,factories,serializers],
180+
--exclude Do not annotate fixtures, test files, factories, and/or serializers
179181
-f [bare|rdoc|markdown], Render Schema Infomation as plain/RDoc/Markdown
180182
--format
181183
--force Force new annotations even if there are no changes.
184+
--timestamp Include timestamp in (routes) annotation
182185
--trace If unable to annotate a file, print the full stack trace, not just the exception message.
183-
--timestamp Include an updated time in routes.rb
186+
-I, --ignore-columns REGEX don't annotate columns that match a given REGEX (i.e., `annotate -I '^(id|updated_at|created_at)'`
187+
184188

185189

186190
== Sorting

0 commit comments

Comments
 (0)