diff options
| author | Annie-Claude Côté <hello@annie.codes> | 2018-06-26 17:18:29 -0400 |
|---|---|---|
| committer | Annie-Claude Côté <hello@annie.codes> | 2018-07-03 21:27:22 -0400 |
| commit | 1edc7263c897f92b019d469b2861eb92419308da (patch) | |
| tree | fab487ea8cf1364d89f10eff3deed0f41dc71891 /railties | |
| parent | 565ce0eaba233fcdd196c11715a8740bd571fd31 (diff) | |
| download | rails-1edc7263c897f92b019d469b2861eb92419308da.tar.gz rails-1edc7263c897f92b019d469b2861eb92419308da.tar.bz2 rails-1edc7263c897f92b019d469b2861eb92419308da.zip | |
[ci skip] Update documentation related to `rails notes`
* Get rid of references to rake notes in the documentation
* Get rid of references to environement variables used in SourceAnnotationExtractor
* Updates the command line guide to reflect the new rails notes API
Diffstat (limited to 'railties')
| -rw-r--r-- | railties/lib/rails/source_annotation_extractor.rb | 14 |
1 files changed, 3 insertions, 11 deletions
diff --git a/railties/lib/rails/source_annotation_extractor.rb b/railties/lib/rails/source_annotation_extractor.rb index 7257aaeaae..884469e20e 100644 --- a/railties/lib/rails/source_annotation_extractor.rb +++ b/railties/lib/rails/source_annotation_extractor.rb @@ -8,12 +8,7 @@ SourceAnnotationExtractor = ActiveSupport::Deprecation::DeprecatedConstantProxy. new("SourceAnnotationExtractor", "Rails::SourceAnnotationExtractor") module Rails - # Implements the logic behind the rake tasks for annotations like - # - # rails notes - # rails notes:optimize - # - # and friends. See <tt>rails -T notes</tt> and <tt>railties/lib/rails/tasks/annotations.rake</tt>. + # Implements the logic behind <tt>Rails::Command::NotesCommand</tt>. See <tt>rails notes --help</tt> for usage information. # # Annotation objects are triplets <tt>:line</tt>, <tt>:tag</tt>, <tt>:text</tt> that # represent the line where the annotation lives, its tag, and its text. Note @@ -64,10 +59,7 @@ module Rails # Prints all annotations with tag +tag+ under the root directories +app+, # +config+, +db+, +lib+, and +test+ (recursively). # - # Additional directories may be added using a comma-delimited list set using - # <tt>ENV['SOURCE_ANNOTATION_DIRECTORIES']</tt>. - # - # Directories may also be explicitly set using the <tt>:dirs</tt> key in +options+. + # Specific directories can be explicitly set using the <tt>:dirs</tt> key in +options+. # # Rails::SourceAnnotationExtractor.enumerate 'TODO|FIXME', dirs: %w(app lib), tag: true # @@ -75,7 +67,7 @@ module Rails # # See <tt>#find_in</tt> for a list of file extensions that will be taken into account. # - # This class method is the single entry point for the rake tasks. + # This class method is the single entry point for the `rails notes` command. def self.enumerate(tag, options = {}) extractor = new(tag) dirs = options.delete(:dirs) || Annotation.directories |