An open API service indexing awesome lists of open source software.

https://github.com/formapro/testo

Use your tests as examples for the doc.
https://github.com/formapro/testo

Last synced: about 1 year ago
JSON representation

Use your tests as examples for the doc.

Awesome Lists containing this project

README

          

Testo [![Build Status](https://secure.travis-ci.org/formapro/testo.png?branch=master)](http://travis-ci.org/formapro/testo)
=====

Do you remember those outdated examples in a documentation?.

Or times while updating documents you had to test examples manually?

This days in the past. Testo come into play.

Example
=======

Let's say you have a `README.md`:

```
@testo examples/Testo/Examples/README.md {
Some description of the awesome code:

@testo 35a8d2d426c05614551484dcdd450f37 }
```

and there is a class:

```php
// @testo Testo\Examples\Hello {
// @testo }
```

So after you run `Testo` there will be clean `README.md`:

```
@testo examples/Testo/Examples/README.md.expected {
Some description of the awesome code:

@testo 35a8d2d426c05614551484dcdd450f37 }
```

What's inside?
==============

```php