Add ApiMayChange warning in docs of StreamRefs (#24389)

* Add ApiMayChange warning in docs of StreamRefs

* Update stream-refs.md
This commit is contained in:
Konrad `ktoso` Malawski 2018-01-23 23:34:11 +09:00 committed by GitHub
parent b12b3740e3
commit 49b59083e2
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -1,4 +1,13 @@
# Akka Streams over network boundaries
# StreamRefs - streams over network boundaries
@@@ warning
This module is currently marked as @ref:[may change](../common/may-change.md) in the sense
of being the subject of active research. This means that API or semantics can
change without warning or deprecation period and it is not recommended to use
this module in production just yet—you have been warned.
@@@
Stream references, or "stream refs" for short, allow running Akka Streams across multiple nodes within
an Akka Cluster.