-
Notifications
You must be signed in to change notification settings - Fork 39
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
Add API Documentation #2
Comments
I came here too to look for documentation & usage examples. I think the empty readme might put off potential users and at least some basic usage examples would be nice. Could also add links to point where users can find more info about marble testing (e.g. https://github.com/ReactiveX/rxjs/blob/master/doc/writing-marble-tests.md). |
I've submitted PR #9 as a starting point for library documentation. |
The fact this repo has no formal |
+1, especially since the Angular docs are recommending this package. The two links in the readme are either broken or seem to be irrelevant. It would be nice to get at least a basic writeup of what this package does, and how it's different from using https://rxjs-dev.firebaseapp.com/guide/testing/marble-testing. |
Gaps:
hot
andcold
- Difference between the two, how to assign values, valid string syntaxgetTestScheduler
- Why you might need this when testing streams that require custom schedulersThe text was updated successfully, but these errors were encountered: