Skip to content

YARD Plugin example that documents RSpec code (live example in homepage)

License

Notifications You must be signed in to change notification settings

Jesus/yard-tests-rspec

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

15 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Embedding RSpec Specifications in YARD Documentation

This plugin demonstrates how RSpec tests can be embedded within standard documentation using only a small amount of plugin code. The example generates documentation for the following {String#pig_latin} method and RSpec tests:

# Run `yardoc -e ../lib/yard-rspec example_code.rb`

class String
  # Pig latin of a String
  def pig_latin
    self[1..-1] + self[0] + "ay"
  end
end

#
# Specs
#
describe String, '#pig_latin' do
  it "should be a pig!" do
    "hello".pig_latin.should == "ellohay"
   end

  it "should fail to be a pig!" do
    "hello".pig_latin.should == "hello"
  end
end

View the “Specifications” section within the {String#pig_latin} method to see these tests.

About

YARD Plugin example that documents RSpec code (live example in homepage)

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Ruby 82.4%
  • HTML 16.0%
  • CSS 1.6%