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

Commit

Permalink
Add motivation
Browse files Browse the repository at this point in the history
  • Loading branch information
Kimmo Brunfeldt committed Mar 30, 2014
1 parent 735b381 commit 84704a3
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
[![Coverage Status](https://coveralls.io/repos/kimmobrunfeldt/egtest/badge.png?branch=master)](https://coveralls.io/r/kimmobrunfeldt/egtest?branch=master)
[![Badge fury](https://badge.fury.io/py/egtest.png)](https://badge.fury.io/py/egtest.png)

Incorrect example is worse than no example at all. *E.g. test* parses code blocks from documentation, runs them and reports possible errors. Your examples can be written in any language.
Incorrect example is worse than no example at all. *E.g. test* parses code blocks from documentation, runs them and reports possible errors. Your examples can be written in any language. There are similar projects but [they didn't suit my needs](#motivation).

**Example**

Expand Down Expand Up @@ -101,6 +101,11 @@ It is possible to define custom code which will be injected on each example befo

*Currently there's no sensible way to add custom injections without modifying [egtest/injecthooks.py](egtest/injecthooks.py).*


## 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.

## Contributing

[Documentation for Egtest developers](docs/)

0 comments on commit 84704a3

Please sign in to comment.