reactor/reactor-core

Inconsistency in marble illustration for Flux.scan

Open

#4.042 geöffnet am 23. Juni 2025

Auf GitHub ansehen
 (1 Kommentar) (0 Reaktionen) (0 zugewiesene Personen)Java (1.164 Forks)batch import
help wantedtype/documentation

Repository-Metriken

Stars
 (4.748 Stars)
PR-Merge-Metriken
 (Durchschn. Merge 16T 15h) (25 gemergte PRs in 30 T)

Beschreibung

Documentation Issue

The current marble illustrations for Flux.scan with initial value and initial value supplier seem misleading to me, as the behaviour of both operators is very similar. On one hand, scan.svg shows no initial value before the processing of the stream, which is inconsistent with what the docstring says. On the other hand, scanWith.svg has an initial value, but wierdly ignores it in the second iteration (green marble), which is also inconsistent with the docstring.

I hope I got this correctly, if not thank you for correcting my understanding.

Improvement Suggestion

I think both illustrations should be similar, with an initial value represented as the white square, followed by the accumulation with input flux items.

Additional context

I would gladly propose the change myself, but I don't know where to find the base material to generate those marble SVGs.

Contributor Guide

Research-Richtung
Das Problem identifiziert Inkonsistenzen in den Marmordiagrammen für Flux.scan. Die zu korrigierenden Dateien sind scan.svg und scanWith.svg im Verzeichnis reactor core/src/main/java/reactor/core/publisher/doc files/marbles. Die aktuellen Diagramme stellen das in den Docstrings beschriebene Verhalten nicht genau dar; der Anfangswert sollte als weißes Quadrat vor der Akkumulation der Eingabeelemente angezeigt werden. Überprüfen Sie die Docstrings für scan und scanWith, um sicherzustellen, dass die SVGs dem beschriebenen Verhalten entsprechen.
Tech Stack
java
Domain
backend
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
1
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Git
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
80