Skip to content

4.x: Reactive streams doc alignment #6458 #7723

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Oct 11, 2023
Merged

4.x: Reactive streams doc alignment #6458 #7723

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/includes/reactivestreams/engine.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
///////////////////////////////////////////////////////////////////////////////

Copyright (c) 2020, 2022 Oracle and/or its affiliates.
Copyright (c) 2020, 2023 Oracle and/or its affiliates.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
Expand Down Expand Up @@ -45,7 +45,7 @@ include::{rootdir}/includes/dependencies.adoc[]

== Usage

Stream processing operator chain can be easily constructed by `io.helidon.common.reactive.Multi`, or
The stream processing operator chain can be easily constructed by `io.helidon.common.reactive.Multi`, or
`io.helidon.common.reactive.Single` for streams with single value.

[source,java]
Expand Down Expand Up @@ -138,7 +138,7 @@ Single.just("1")

|===

=== Operator chains composition
=== Operator Chains Composition

In the situations when part of the operator chain needs to be prepared in advance,
`compose` and `to` operators are at hand.
Expand Down
9 changes: 5 additions & 4 deletions docs/includes/reactivestreams/rsoperators.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
///////////////////////////////////////////////////////////////////////////////

Copyright (c) 2020, 2022 Oracle and/or its affiliates.
Copyright (c) 2020, 2023 Oracle and/or its affiliates.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
Expand Down Expand Up @@ -29,7 +29,7 @@ ifndef::rootdir[:rootdir: {docdir}/../..]

== Overview

Helidon implements link:{microprofile-rs-operators-spec-url}[MicroProfile Reactive Streams Operators] specification which defines reactive operators and provides a standartized tool for manipulation with https://www.reactive-streams.org/[Reactive Streams]. Use it you want stick with MicroProfile ecosystem which guarantees source-level portability between different implementations of the specification.
Helidon implements link:{microprofile-rs-operators-spec-url}[MicroProfile Reactive Streams Operators] specification which defines reactive operators and provides a standardized tool for manipulation with https://www.reactive-streams.org/[Reactive Streams]. You can use MicroProfile Reactive Streams Operators when you want to maintain source-level portability between different implementations.


include::{rootdir}/includes/dependencies.adoc[]
Expand All @@ -44,7 +44,8 @@ include::{rootdir}/includes/dependencies.adoc[]

== Usage

The specification provides a set of operators as so called stages, and the builders to prepare graphs of stages for streams to be build from.
The MicroProfile Reactive Streams Operators specification provides a set of operators within stages,
as well as the builders used to prepare graphs of stages from which streams can be built.

[source,java]
.Example of simple closed graph usage:
Expand Down Expand Up @@ -106,7 +107,7 @@ ReactiveStreams.of("1", "2", "3", "4", "5")
=== Graphs

link:{microprofile-rs-operators-spec-url}#_graphs[Graphs] are pre-prepared stream builders with
link:{microprofile-rs-operators-spec-url}#_stages[stages], which can be combined together to closed graph with methods
link:{microprofile-rs-operators-spec-url}#_stages[stages], which can be combined to closed graph with methods
`via` and `to`.

[source,java]
Expand Down