module Kernel

Define todo- and fixme commands to global usage.

end¶ ↑

Public Instance Methods

fixme( comment = 'FixMe', &block) click to toggle source

Add a fixme-command.

Can be used to mark available code.

end¶ ↑

# File lib/todonotes/kernel.rb, line 40
def fixme( comment = 'FixMe', &block)
  raise NotImplementedError if Todonotes::TODONOTES.raise_fixme?
  Todonotes::TODONOTES.todo(comment, :FixMe, &block)
end

to( comment = 'ToDo', &block)

Usage:

to do 
  :result
end

end¶ ↑

Alias for: todo

todo( comment = 'ToDo', &block) click to toggle source

Usage 1 (only message):

todo "my todo-message""

Usage 2 (only temporary result):

todo { "temporary result" }
todo do
  "temporary result"
end

Usage 3(message and temporary result):

todo ('message') { "temporary  result" }
todo ('message') do
  "temporary result"
end

end¶ ↑

# File lib/todonotes/kernel.rb, line 22
def todo( comment = 'ToDo', &block)
  raise NotImplementedError if Todonotes::TODONOTES.raise_todo?
  Todonotes::TODONOTES.todo(comment, &block)
end

Also aliased as: to