Skip to content
This repository has been archived by the owner on Aug 16, 2021. It is now read-only.

Commit

Permalink
Add info to motivation
Browse files Browse the repository at this point in the history
  • Loading branch information
Kimmo Brunfeldt committed Mar 30, 2014
1 parent bfd2378 commit 596080e
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ It is possible to define custom code which will be injected on each example befo

## Motivation

I wrote this to test [examples for Nap](https://github.com/kimmobrunfeldt/nap#examples), which is a convenience wrapper for *requests*. [Doctest](https://docs.python.org/2/library/doctest.html) has similar functionality but you need to start every line in example with `>>>`. It makes the example harder to follow. [Sphinx](http://sphinx-doc.org/) supports running examples like *egtest* does but Sphinx is a bit heavyweight and it supports only Python.
I wrote this to test [examples for Nap](https://github.com/kimmobrunfeldt/nap#examples), which is a convenience wrapper for *requests*. Nap's examples are tested for each commit with Travis CI. [Doctest](https://docs.python.org/2/library/doctest.html) has similar functionality but you need to start every line in example with `>>>`. It makes the examples harder to follow. [Sphinx](http://sphinx-doc.org/) supports running examples like *egtest* does but Sphinx is a bit heavyweight and it supports only Python.

## Contributing

Expand Down

0 comments on commit 596080e

Please sign in to comment.