module Proof

Public Class Methods

start() click to toggle source

# File lib/proof/proof.rb, line 34
def self.start
  CoreExt::Object::Methods.define_prove
end

stop() click to toggle source

# File lib/proof/proof.rb, line 38
def self.stop
  CoreExt::Object::Methods.undefine_prove
end

Public Instance Methods

block(heading='')

Alias for: section

comment(comment) click to toggle source

# File lib/proof/proof.rb, line 30
def comment(comment)
  Proof::Output.note comment
end

desc(description) click to toggle source

# File lib/proof/proof.rb, line 10
def desc(description)
  Proof::Description.current = description
end

heading(heading) { || ... } click to toggle source

# File lib/proof/proof.rb, line 18
def heading(heading)
  Proof::Output.h2 heading
  yield if block_given?
end

proof(description=nil) { || ... } click to toggle source

# File lib/proof/proof.rb, line 2
def proof(description=nil, &block)
  Proof::Description.current = description
  Proof.start
  yield
  Proof.stop
  Proof::Description.current = nil
end

section(heading='') { || ... } click to toggle source

# File lib/proof/proof.rb, line 23
def section(heading='')
  meth = heading.empty? ? :sect : :heading
  Proof::Output.send meth, heading
  yield if block_given?
end

Also aliased as: block

title(title) click to toggle source

# File lib/proof/proof.rb, line 14
def title(title)
  Proof::Output.h1 title
end