Documentation... - Githubissues

phuccaoca123 / mb-unit

Automatically exported from code.google.com/p/mb-unit

0 stars 0 forks source link

Documentation... #87

Closed GoogleCodeExporter closed 9 years ago

GoogleCodeExporter commented 9 years ago

What steps will reproduce the problem?

1. Open API reference pages
2. Click on any class...
3.

What is the expected output? What do you see instead?

Expected output is an explanation of each class goal, with a little 
example showing how to use it in a practical case. Instead, we can see an 
ugly auto generated class reference, and nothing more.

Com'on, provide us a real documentation !! I really think MbUnit is far 
better than any concurrent, but actually NUnit might be a preferable 
choice since all cool features offered by MbUnit are stealth in a so 
crappy documentation...

Original issue reported on code.google.com by apaut...@gmail.com on 22 Oct 2007 at 8:39

GoogleCodeExporter commented 9 years ago

Acknowledged and understood. 
We're moving the MbUnit 2 asserts and attributes into v3 at the moment and will 
aim 
to document them all possibly for beta 1. 

We'll backport the documentation back into v2.4 and online as well once that is 
done.

Original comment by dan.maha...@gmail.com on 31 Oct 2007 at 3:07

Changed state: Accepted
Added labels: Type-Enhancement
Removed labels: Type-Defect

GoogleCodeExporter commented 9 years ago

This is a major objective for MbUnit v3 especially.

I'm not sure we'll actually backport all of the docs to v2 in the end, but 
we'll see
what happens and how much time we have.

There's also been talk of an MbUnit Book.

Want to help?

Original comment by jeff.br...@gmail.com on 18 Jan 2008 at 12:31

Added labels: Component-Docs, Milestone-3.0-final, Priority-High
Removed labels: Priority-Medium

GoogleCodeExporter commented 9 years ago

API Docs for MbUnit 3 are already covered by Jeff et al, and we'll start 
pushing the
rest of the Gallio book shortly. 

API Docs for MbUnit 2 are probably as covered as they will ever be now unless 
there
is a major outcry to complete docs for the whole API. 

Going to close this issue now in favour of 322 for finishing the v2 docs and 
opening
new, more focussed tasks for the book.

Original comment by dan.maha...@gmail.com on 11 Apr 2009 at 3:57

Changed state: Fixed