From 5d699d08880a863237871660e5af2ac34021f72d Mon Sep 17 00:00:00 2001 From: "Andrew W. Lee" Date: Tue, 17 Dec 2019 08:04:18 -0800 Subject: [PATCH 1/2] 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. --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 5909ecc8d..178c7e12b 100644 --- a/README.md +++ b/README.md @@ -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 @@ -254,7 +254,7 @@ you can do so with a simple environment variable, instead of editing the ### Option: `additional_file_patterns` -CLI: `--additional_file_patterns`
+CLI: `--additional-file-patterns`
Ruby: `:additional_file_patterns` Provide additional paths for the gem to annotate. These paths can include From ff5575b509970a8d99b7faac56ec7cb92410c07f Mon Sep 17 00:00:00 2001 From: "Andrew W. Lee" Date: Tue, 17 Dec 2019 08:06:48 -0800 Subject: [PATCH 2/2] Tidy: Replace `*` with `*` Doing some tidying now that we switched from RDoc to markdown. --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 178c7e12b..c0b9c390b 100644 --- a/README.md +++ b/README.md @@ -260,9 +260,9 @@ 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%/*.rb` -* `/app/lib/forms/%PLURALIZED_MODEL_NAME%/**/*.rb` -* `/app/lib/forms/%TABLE_NAME%/*.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