docs for testScheduler.run() #3612
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jayphelps
commented
Apr 27, 2018
| @@ -0,0 +1,188 @@ | |||
| > NOTE: This document refers to the writing marble tests for the **RxJS repo internals** and is intended for anyone wishing to help maintain the RxJS repo. **Users of RxJS** should instead view the [guide for writing marbles tests for applications](./marble-testing.md). The major difference is that the behavior of the TestScheduler differs between manual usage and using the `testScheduler.run(callback)` helper. | |||
|
|
|||
| # Writing Marble Tests | |||
There was a problem hiding this comment.
This file is just a copy and paste from the existing old writing-marble-tests.md, with the added disclaimer at the top.
jayphelps
commented
Apr 27, 2018
doc/writing-marble-tests.md
Outdated
|
|
||
| Then, when running `npm run tests2png`, this test case will be parsed and a PNG file `zip.png` (filename determined by `${operatorLabel}.png`) will be created in the `img/` folder. | ||
| - [USERS: Writing marble diagram tests for your application](./marble-testing.md). | ||
| - [INTERNAL MAINTAINERS ONLY: Writing marble diagram tests for your the RxJS internals](./internal-marble-tests.md). |
There was a problem hiding this comment.
I imagine even though this doc was written with the intended audience being maintainers of rxjs itself, some people have linked to this doc so to aid in their search I added this links.
jayphelps
force-pushed
the
marble-docs
branch
2 times, most recently
from
1f6c239 to
ccf68a5
Compare
benlesh
approved these changes
May 3, 2018
jayphelps
changed the title
|
This thread has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Follow up to #3596 which introduced the new
testScheduler.run(callback)helper.Not done yet, needs more content and the content already here is likely to change. If you have suggestions or examples feel free to comment! One thing I think is a good idea is to move the content of the existing writing-marble-tests.md file and clarifying that it's particular content is intended for internal rxjs tests, not tests in your client apps. This new file I'm introducing is intended for client apps.
When it's ready I'd like to solicit feedback from people who know RxJS relatively well but have never used TestScheduler.