Skip to content

Inconsistency in marble illustration for Flux.scan #4042

@lexum-letardv

Description

@lexum-letardv

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions