Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Update the README fix the latest output format

  • Loading branch information...
commit 947e53a61a6614b05fec4e73064c5db1264beae5 1 parent a1dad4f
@dasch authored
Showing with 13 additions and 4 deletions.
  1. +2 −0  .gitignore
  2. +11 −4 README.mkd
View
2  .gitignore
@@ -4,3 +4,5 @@ pkg/*
.rvmrc
Gemfile.lock
tmp
+.yardoc
+doc
View
15 README.mkd
@@ -12,12 +12,19 @@ Simply create a new `ToDoTask` in your Rakefile:
ToDoTask.new
Running `rake todo` will now output all `TODO` items in your `lib/` and `test/`
-directories:
+directories. Say you have a file `test/foomatic/foo.rb` with the contents
+ class Monkey
+ # TODO: Make this lazy monkey do something!
+ # TODO: Also, can we make it dance?
+ end
+
+When you run `rake todo`, you'll see
+
+ $ rake todo
test/foomatic/foo.rb:
- * 007: Simplify!
- * 010: Make this more awesome!
-
+ * TODO: Make this lazy monkey do something! (line 2)
+ * TODO: Also, can we make it dance? (line 3)
ToDo items: 2
Please sign in to comment.
Something went wrong with that request. Please try again.