Skip to content

Commit 8676f61

Browse files
drwlpeterfication
authored andcommitted
Tidy README (ctran#701)
* Fix instances of `additional file patterns` in README Other CLI flags are using dash, so using `--additional-file-patterns` notation to keep it similar to others. * Tidy: Replace `*` with `*` Doing some tidying now that we switched from RDoc to markdown.
1 parent c19d965 commit 8676f61

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -199,7 +199,7 @@ you can do so with a simple environment variable, instead of editing the
199199
## Options
200200

201201
Usage: annotate [options] [model_file]*
202-
--additional_file_patterns Additional file paths or globs to annotate, separated by commas (e.g. `/foo/bar/%model_name%/*.rb,/baz/%model_name%.rb`)
202+
--additional-file-patterns Additional file paths or globs to annotate, separated by commas (e.g. `/foo/bar/%model_name%/*.rb,/baz/%model_name%.rb`)
203203
-d, --delete Remove annotations from all model files or the routes.rb file
204204
-p [before|top|after|bottom], Place the annotations at the top (before) or the bottom (after) of the model/test/fixture/factory/route/serializer file(s)
205205
--position
@@ -254,15 +254,15 @@ you can do so with a simple environment variable, instead of editing the
254254

255255
### Option: `additional_file_patterns`
256256

257-
CLI: `--additional_file_patterns`<br>
257+
CLI: `--additional-file-patterns`<br>
258258
Ruby: `:additional_file_patterns`
259259

260260
Provide additional paths for the gem to annotate. These paths can include
261261
globs. It is recommended to use absolute paths. Here are some examples:
262262

263-
* `/app/lib/decorates/%MODEL_NAME%/&ast;.rb`
264-
* `/app/lib/forms/%PLURALIZED_MODEL_NAME%/&ast;&ast;/&ast;.rb`
265-
* `/app/lib/forms/%TABLE_NAME%/&ast;.rb`
263+
* `/app/lib/decorates/%MODEL_NAME%/*.rb`
264+
* `/app/lib/forms/%PLURALIZED_MODEL_NAME%/**/*.rb`
265+
* `/app/lib/forms/%TABLE_NAME%/*.rb`
266266

267267

268268
The appropriate model will be inferred using the `%*%` syntax, annotating any

0 commit comments

Comments
 (0)