GitHub user bowenli86 opened a pull request:
https://github.com/apache/flink/pull/5129
[Hotfix for State doc in 1.4 and 1.5] update State's doc and javaDoc to
clarify replacement of foldingstate
## What is the purpose of the change
Clarify that `aggregatingstate` is the replacement of `foldingstate` rather
than giving users ambiguous hint in both Flink doc and javaDoc
Please merge this back to 1.4 as well
## Brief change log
- updated Flink's State doc
- added 'in favor of {@link AggregatingState}' to deprecated APIs, making
them similar to javaDocs of `FoldingStateDescriptor.java`
## Verifying this change
none
## Does this pull request potentially affect one of the following parts:
none
## Documentation
- If yes, how is the feature documented? (docs / java docs)
You can merge this pull request into a Git repository by running:
$ git pull https://github.com/bowenli86/flink hotfix
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/flink/pull/5129.patch
To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:
This closes #5129
----
commit 2419562948cffa6641b1075a6e67184f3cbe2eda
Author: Bowen Li <[email protected]>
Date: 2017-12-06T19:37:54Z
update State's doc and javaDoc to clarify replacement of foldingstate
----
---
