-
Notifications
You must be signed in to change notification settings - Fork 7.6k
1.x: add missing backpressure descriptions and update old ones #4172
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
Conversation
"...it <t>may</i> lead to IllegalStateException being throw..." ...but better yet would be to avoid the passive voice and indicate what entity throws the exception, e.g. "If any of the source Observables violate this, XXX may throw an IllegalStateException when the source Observable completes." |
"...no backpressue applied to them..." => "...no backpressure applied to them..." |
"The other Observables supplied by the function is consumed..." => "The other Observables supplied by the function are consumed..." |
I notice that some of the |
typo: "...apply any of the |
For operators that both accept and return an Observable (most of them), I find the phrase "this Observable" in the documentation to be ambiguous: does it mean the Observable about to be operated on, or the Observable that results from the operation? I'd recommend replacing it with "the source Observable" or "the resulting Observable" or something like that, depending on which one you're talking about. |
typo: "...the output's backpressure behavior is derermined by..." => "...the output's backpressure behavior is determined by..." |
That last line seems to be extraneous. |
Some of those typos appear in multiple places in the file. It's great to see these sections getting filled out and made more precise! |
Thanks for the review. I've updated the text. |
Current coverage is 81.46%@@ 1.x #4172 diff @@
==========================================
Files 257 257
Lines 16823 16823
Methods 0 0
Messages 0 0
Branches 2550 2550
==========================================
+ Hits 13697 13705 +8
+ Misses 2226 2225 -1
+ Partials 900 893 -7
|
I'm merging this so work touching |
Thank you for this @akarnokd! |
Beaut! |
This PR adds or updates places where the
Backpressure:
description was missing or outdated.Unfortunately, GitHub has a hard limit on diff size per file so reviewers have to use their own local diff.