Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document something about this library's use #9

Open
rektide opened this issue Jun 28, 2013 · 2 comments
Open

Document something about this library's use #9

rektide opened this issue Jun 28, 2013 · 2 comments

Comments

@rektide
Copy link

rektide commented Jun 28, 2013

There is no online documentation showing this library off or describing the capabilities it offers.

The tests would be a sufficient starting place, would that the source be visible and not just recite "pass.

@fogus
Copy link
Owner

fogus commented Jun 28, 2013

I don't understand the last sentence, but in any case I do agree with the need for docs. However, that is a task that shall be deferred as my attentions are drawn elsewhere at the moment. Thank you for the interest.

@rektide
Copy link
Author

rektide commented Jun 28, 2013

Re, "tests would be a sufficient starting place"

The "spec" link on the homepage take us to http://fogus.github.io/lemonad/test.html

That page declares what various behaviors of the library are, but provides no visibility into what to do to get that behavior. If that page (a test runner) also linked or showed source for any given test, I believe it would serve excellently as documentation.

Is this "jasmine_reporter" stock in Jasmine, or did you supplement Jasmine with additional reporting libraries, and if so, what? I myself would consider hacking this upstream in Jasmine if applicable, but I am not sure how much of it is your own design, how much is Jasmine, and whether there's other test running libraries that might have gone into it's creation.

Thanks fogus.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants