Unverified Commit a631f5ad by Andrew W. Lee Committed by GitHub

Tidy README (#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.
parent c13fe49c
...@@ -199,7 +199,7 @@ you can do so with a simple environment variable, instead of editing the ...@@ -199,7 +199,7 @@ you can do so with a simple environment variable, instead of editing the
## Options ## Options
Usage: annotate [options] [model_file]* Usage: annotate [options] [model_file]*
--additional_file_patterns Additional file paths or globs to annotate, separated by commas (e.g. `/foo/bar/%model_name%/*.rb,/baz/%model_name%.rb`) --additional-file-patterns Additional file paths or globs to annotate, separated by commas (e.g. `/foo/bar/%model_name%/*.rb,/baz/%model_name%.rb`)
-d, --delete Remove annotations from all model files or the routes.rb file -d, --delete Remove annotations from all model files or the routes.rb file
-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) -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)
--position --position
...@@ -254,15 +254,15 @@ you can do so with a simple environment variable, instead of editing the ...@@ -254,15 +254,15 @@ you can do so with a simple environment variable, instead of editing the
### Option: `additional_file_patterns` ### Option: `additional_file_patterns`
CLI: `--additional_file_patterns`<br> CLI: `--additional-file-patterns`<br>
Ruby: `:additional_file_patterns` Ruby: `:additional_file_patterns`
Provide additional paths for the gem to annotate. These paths can include Provide additional paths for the gem to annotate. These paths can include
globs. It is recommended to use absolute paths. Here are some examples: globs. It is recommended to use absolute paths. Here are some examples:
* `/app/lib/decorates/%MODEL_NAME%/&ast;.rb` * `/app/lib/decorates/%MODEL_NAME%/*.rb`
* `/app/lib/forms/%PLURALIZED_MODEL_NAME%/&ast;&ast;/&ast;.rb` * `/app/lib/forms/%PLURALIZED_MODEL_NAME%/**/*.rb`
* `/app/lib/forms/%TABLE_NAME%/&ast;.rb` * `/app/lib/forms/%TABLE_NAME%/*.rb`
The appropriate model will be inferred using the `%*%` syntax, annotating any The appropriate model will be inferred using the `%*%` syntax, annotating any
......
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