Skip to content

Commit

Permalink
Improve readme
Browse files Browse the repository at this point in the history
  • Loading branch information
jubianchi committed May 15, 2015
1 parent bc566c2 commit 8a559ac
Showing 1 changed file with 23 additions and 0 deletions.
23 changes: 23 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,3 +43,26 @@ atoum provides 3 aliases for the main test class, choose the one you prefer:
Once done, you will get full featured code-completion:

![atoum-stubs](demo.gif)

## Why?

> Why are the PHPdoc annotations part of an external repository?
Because we just don't want them in the middle of atoum's source code. It's not really useful there and it adds extra
noise.

Moreover, if we use PHPDoc for the userland API we should also add annotations to every method of the internal API. Too
much work for a small amount of added value.

> Why are those annotations only working on atoum aliases?
Because we stored annotated code in an external repository, we would have to duplicate some classes to annotate them.
Doing so would create duplicate classes and some IDEs will emit warnings.

We don't want to add extra noise while providing a good code-completion.

> Why not annotating every public method?
Because they are not all meaningful in a test context. When you write unit tests with atoum, you will likely never call
internal asserters' methods, even if they are public. They provide support for atoum so it can do its job well. But they
won't help you in your everyday work.

0 comments on commit 8a559ac

Please sign in to comment.