Project

erudite

0.0
Repository is archived
No commit activity in last 3 years
No release in over 3 years
Executable documentation.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

~> 0.7
~> 10.4
~> 3.1
~> 0.28

Runtime

~> 2.2
 Project Readme

Version Build Coverage Climate Dependencies

Test interactive Ruby examples.

Erudite helps you turn your documentation into tests. It is like a Ruby version of the Python doctest module.

  • Installation
  • Usage

Installation

To add Erudite as a dependency to your project, add it to your Gemfile.

gem 'erudite', '~> 0.3.0'

For other use cases, install it manually.

$ gem install erudite --version '~> 0.3.0'

Erudite uses Semantic Versioning. See the change log for a detailed list of changes.

Usage

# >> f(3)
# => 9
def f(x)
  x**2
end
$ erudite example.rb
- PASS