diff options
| author | Vijay Dev <vijaydev.cse@gmail.com> | 2011-06-15 22:53:26 +0530 |
|---|---|---|
| committer | Vijay Dev <vijaydev.cse@gmail.com> | 2011-06-15 22:53:57 +0530 |
| commit | 3e441596509bbb5eb485c60efe78a629c028562e (patch) | |
| tree | 4e00d2fd5314506b749d78157481f0cf38786d04 /railties | |
| parent | 1adb38b6c3da1f651fbf6afced320b122b81dbc1 (diff) | |
| download | rails-3e441596509bbb5eb485c60efe78a629c028562e.tar.gz rails-3e441596509bbb5eb485c60efe78a629c028562e.tar.bz2 rails-3e441596509bbb5eb485c60efe78a629c028562e.zip | |
document how rake notes work
Diffstat (limited to 'railties')
| -rw-r--r-- | railties/guides/source/command_line.textile | 23 |
1 files changed, 22 insertions, 1 deletions
diff --git a/railties/guides/source/command_line.textile b/railties/guides/source/command_line.textile index 6110846b19..c71baa76d1 100644 --- a/railties/guides/source/command_line.textile +++ b/railties/guides/source/command_line.textile @@ -402,7 +402,28 @@ If you want to strip out or rebuild any of the Rails documentation (including th h4. +notes+ -These tasks will search through your code for commented lines beginning with "FIXME", "OPTIMIZE", "TODO", or any custom annotation (like XXX) and show you them. ++rake notes+ will search through your code for comments beginning with FIXME, OPTIMIZE or TODO. This checks only for files with extension +.builder+, +.rb+, +.rxml+, +.rhtml+ and +.erb+. + +<shell> +$ rake notes +(in /home/foobar/commandsapp) +app/controllers/admin/users_controller.rb: + * [ 20] [TODO] any other way to do this? + * [132] [FIXME] high priority for next deploy + +app/model/school.rb: + * [ 13] [OPTIMIZE] refactor this code to make it faster + * [ 17] [FIXME] +</shell> + +You can also use custom annotations in your code and list them using +rake notes:custom+ and specify the annotation using an environment variable +ANNOTATION+. + +<shell> +$ rake notes:custom ANNOTATION=BUG +(in /home/foobar/commandsapp) +app/model/post.rb: + * [ 23] Have to fix this one before pushing! +</shell> h4. +routes+ |