Skip to content

Tidy README #701

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Dec 18, 2019
Merged

Tidy README #701

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5d699d0
Fix instances of `additional file patterns` in README
drwl Dec 17, 2019
ff5575b
Tidy: Replace `*` with `*`
drwl Dec 17, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -199,7 +199,7 @@ you can do so with a simple environment variable, instead of editing the
## Options

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
-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
Expand Down Expand Up @@ -254,15 +254,15 @@ you can do so with a simple environment variable, instead of editing the

### Option: `additional_file_patterns`

CLI: `--additional_file_patterns`<br>
CLI: `--additional-file-patterns`<br>
Ruby: `:additional_file_patterns`

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

* `/app/lib/decorates/%MODEL_NAME%/&ast;.rb`
* `/app/lib/forms/%PLURALIZED_MODEL_NAME%/&ast;&ast;/&ast;.rb`
* `/app/lib/forms/%TABLE_NAME%/&ast;.rb`
* `/app/lib/decorates/%MODEL_NAME%/*.rb`
* `/app/lib/forms/%PLURALIZED_MODEL_NAME%/**/*.rb`
* `/app/lib/forms/%TABLE_NAME%/*.rb`


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