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

Add API Documentation #2

Open
MikeRyanDev opened this issue Jul 18, 2017 · 4 comments
Open

Add API Documentation #2

MikeRyanDev opened this issue Jul 18, 2017 · 4 comments
Assignees

Comments

@MikeRyanDev
Copy link
Member

Gaps:

  • hot and cold - Difference between the two, how to assign values, valid string syntax
  • getTestScheduler - Why you might need this when testing streams that require custom schedulers
@cvuorinen
Copy link

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).

@mcattle
Copy link
Contributor

mcattle commented Nov 28, 2017

I've submitted PR #9 as a starting point for library documentation.

@dolanmiu
Copy link

The fact this repo has no formal README or docs made me even question if I've got the right link or not lol

@jacobweber
Copy link

+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.

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

6 participants