4.x: Flowable missing or incorrect marbles (tracking issue)
Open
Nobody has claimed this yet.
4.x
Documentation
PR welcome
- Dominant language
- Java
- Stars
- 48.2k
- Forks
- 7.6k
- Avg merge
- 39m
- Merged PRs (30d)
- 11
Description
-
amb: indicate cancellation and request propagation -
ambArray: indicate cancellation and request propagation -
combineLatest+ 4: missing diagram -
combineLatestDelayError+ 5: missing diagram -
concatArrayDelayError: operator name, indicate error delayed -
concatArrayEager+ 1: missing diagram -
concatArrayEagerDelayError+ 1: missing diagram -
concatDelayError+ 2: missing diagram -
concatEager+ 4: missing diagram -
concatEagerDelayError+ 4: missing diagram -
create: missing diagram -
error(Callable): indicate callback that creates the Throwable - `error(Throwable): indicate parameter
-
fromArray: operator name, indicate items inside the box -
fromCallable: indicate item is the result of the callback inside the box -
fromFuture+ 3: operator name -
fromIterable: operator name, indicate items inside the box -
fromPublisher: missing diagram -
generate+ 4: missing diagram -
intervalRange+ 1: missing diagram -
just+ 8: indicate item inside the box (as many as there are sources, so 1..9) -
mergeArray+ 1: operator name -
mergeArrayDelayError+ 1: operator name -
mergeDelayError+ 1: indicate inner sources are generated -
sequenceEqual+ 3: indicate cancellation after the mismatch has been found -
switchOnNextDelayError+ 1: operator name, indicate error delay -
using+ 1: indicate actual Flowable and items -
zipArray: operator name -
zipIterable: operator name -
all: should return Single -
ambWith: indicate cancellation and request propagation -
exists: should return Single -
: operator removedas: missing diagram -
blockingFirst+ 1: missing diagram -
blockingForEach: operator name -
blockingIterable+ 1: operator name, indicate iterator call tohasNext()andnext() -
blockingLast+ 1: operator name -
blockingLatest: missing diagram -
blockingMostRecent: operator name -
blockingNext: operator name -
blockingSingle+ 1: operator name -
toFuture: rework diagram to indicateFuture -
blockingSubscribe+ 4: missing diagram -
buffer(..., Callable)+ 6: indicate custom collection -
buffer(open, close)+ 1: parameter name in the box -
collect: indicate initial container supplier, should return Single -
collectInto: indicate initial container, should return Single, operator name -
compose: missing diagram -
concatMap(prefetch): indicate prefetch effects through requests -
concatMapDelayError+ 1: missing diagram -
concatMapEager+ 1: missing diagram -
concatMapEagerDelayError+ 1: missing diagram -
concatMapIterable+ 1: missing diagram -
concatWith: operator name -
contains: should return Single -
count: operator name -
defaultIfEmpty: indicate non-empty case -
delaySubscription(Publisher): missing diagram -
dematerialize: indicate dematerializing a terminal notification cancels the source -
doFinally: missing diagram -
doAfterNext: missing diagram -
doOnCancel: operator name, unsubscribe -> cancel in text -
doOnComplete: indicate events pass through -
doOnEach+ 1: indicate events pass through -
doOnError: indicate events pass through -
doOnNext: indicate events pass through -
doOnRequest: missing diagram -
doOnTerminate: indicate events pass through, show both error and complete case -
elementAt: should return Maybe, indicate if source is shorter than index -
elementAtOrDefault: should return Single, indicate if source has that element -
elementAtOrError: should return Single, indicate error case -
firstElement: image aspect off, add case separator dashed vertical line -
first: image aspect off -
firstOrError: combine two sections, vertical separator, empty source arrow -
flatMap(..., delayError): indicate error delay case -
flatMap(..., maxConcurrency)+ 2: missing diagram -
flatMap(Function, Function, Callable, int): missing diagram -
flatMap(Function, BiFunction, boolean, int)+ 1: missing diagram -
flatMap(Function, BiFunction, int): missing diagram -
flatMapCompletable+ 1: missing diagram -
flatMapIterable+ 1: image aspect looks off -
flatMapMaybe+ 1: missing diagram -
flatMapSingle+ 1: missing diagram -
forEach: missing diagram -
forEachWhile+ 2: missing diagram -
hide: missing diagram -
isEmpty: should return Single -
lastElement: operator name, should return Maybe -
last(T): should return Single, operator name -
lastOrError: combine sections into one, add vertical case separator -
limit:missing diagramoperator renamed totake -
mergeWith: operator name, indicate the second source as parameter -
onErrorResumeNext(Function): indicate error function -
onErrorReturn: indicate error function -
onErrorReturnItem: operator name -
onTerminateDetach: missing diagram -
publish(Function)+ 1: rework diagram -
rebatchRequests: missing diagram -
reduce(seed, ...): indicate star as parameter -
reduceWith(Callable,...): indicate star as a supplied value, operator name -
repeat+ 1: indicate resubscription -
repeatUntil: indicate boolean supplier -
replay+ 7: remove publish box -
replay(Function)+ 7: rework diagram -
retry(): indicate infinte resubscription -
retry(BiPredicate): indicate function decision on retry -
retry(long): indicate retry count effect -
retry(long, Predicate): indicate predicate effects -
retry(Predicate): indicate predicate effects -
retryUntil: missing diagram -
scan(R, ...): indicate initialValue as parameter -
scan(Callable, ...): indicate initialValue is the result of a call -
share: indicate the source gets cancelled -
singleElement: operator name, should return Maybe -
single: operator name, should return Single -
singleOrError: combine cases into one box, add vertical case separators -
skipUntil: indicate until cancels the main source -
sorted+ 1: missing diagram -
startWith(Iterable): indicate iterable parameter, indicate subscription -
startWith(Publisher): indicate subscription after the start element(s) -
startWith(T): one start value, indicate subscription after the start element -
startWithArray: operator name, indicate subscription after the start element(s) -
switchMapDelayError+ 1: operator name, indicate error is delayed -
takeUntil(Predicate): indicate source is cancelled -
takeUntil(Publisher): indicate source is cancelled -
takeWhile: indicate source is cancelled -
to: missing diagram -
toList+ 1: should return Single -
toList(Callable): should return Single, indicate custom collection -
toMap+ 2: should return Single -
toMultimap+ 3: should return Single -
toObservable: missing diagram -
toSortedList+ 4: should return Single -
unsubscribeOn: missing diagram -
withLatestFrom(s1, s2, ...): missing diagrams -
withLatestFrom(Publisher[], ...): missing diagram -
withLatestFrom(Iterable, ...): missing diagram
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Use the unchecked entries in the issue checklist as the work list, starting with one Flowable operator and its missing or incorrect marble diagram. Read the existing operator documentation and diagrams in the repository, then verify that the selected diagram reflects the listed names, parameters, cancellation, request propagation, or return type. Done means the targeted checklist item is accurately addressed and checked off.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 25/100