Add API Documentation - Githubissues

CodeSequence / jasmine-marbles

Marble testing helpers for RxJS and Jasmine

MIT License

116 stars 39 forks source link

Add API Documentation #2

Open MikeRyanDev opened 7 years ago

MikeRyanDev commented 7 years ago

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 commented 7 years ago

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 commented 6 years ago

I've submitted PR https://github.com/synapse-wireless-labs/jasmine-marbles/pull/9 as a starting point for library documentation.

dolanmiu commented 6 years ago

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 commented 4 years ago

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