diff options
| author | Prathamesh Sonpatki <csonpatki@gmail.com> | 2016-07-10 20:42:50 +0530 |
|---|---|---|
| committer | Prathamesh Sonpatki <csonpatki@gmail.com> | 2016-07-10 20:42:50 +0530 |
| commit | 816e15d6269ff994ac7ee9e0d391ed74187ed98a (patch) | |
| tree | fe8f54cb847f65cda419eea32d17b8875916f928 /guides | |
| parent | b76808602de772fecae4bd27298f7662aac8436a (diff) | |
| download | rails-816e15d6269ff994ac7ee9e0d391ed74187ed98a.tar.gz rails-816e15d6269ff994ac7ee9e0d391ed74187ed98a.tar.bz2 rails-816e15d6269ff994ac7ee9e0d391ed74187ed98a.zip | |
Add note about `config.annotations.register_directories` option in the guides [ci skip]
- Followup of #25692.
Diffstat (limited to 'guides')
| -rw-r--r-- | guides/source/command_line.md | 8 |
1 files changed, 7 insertions, 1 deletions
diff --git a/guides/source/command_line.md b/guides/source/command_line.md index f766403228..ed8251b0e6 100644 --- a/guides/source/command_line.md +++ b/guides/source/command_line.md @@ -497,7 +497,13 @@ app/models/article.rb: NOTE. When using specific annotations and custom annotations, the annotation name (FIXME, BUG etc) is not displayed in the output lines. -By default, `rails notes` will look in the `app`, `config`, `db`, `lib` and `test` directories. If you would like to search other directories, you can provide them as a comma separated list in an environment variable `SOURCE_ANNOTATION_DIRECTORIES`. +By default, `rails notes` will look in the `app`, `config`, `db`, `lib` and `test` directories. If you would like to search other directories, you can configure them using `config.annotations.register_directories` option. + +```ruby +config.annotations.register_directories("spec", "vendor") +``` + +You can also provide them as a comma separated list in the environment variable `SOURCE_ANNOTATION_DIRECTORIES`. ```bash $ export SOURCE_ANNOTATION_DIRECTORIES='spec,vendor' |