[
https://issues.apache.org/jira/browse/FLINK-3333?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15139150#comment-15139150
]
Greg Hogan commented on FLINK-3333:
-----------------------------------
I think it is most important that the user documentation be clear and concise,
otherwise it won't be read or will discourage new users. Whatever edge cases
may lurk, object reuse appears to have worked well as users naturally write
code.
It would be helpful to include a list of chainable operators (from
DriverStrategy.java: Map, FlatMap, Reduce on full DataSet, GroupCombine on a
Grouped DataSet, or a GroupReduce where the user supplied a
RichGroupReduceFunction with a combine method). Those could be linked to the
DataSet Transformations page.
Some discussion of CopyableValue types such as IntValue, LongValue, and
StringValue would be nice, along with code samples.
I've typed up some edits and will paste into a new comment. I do think that
discussion of user prohibitions (no modifying inputs to a filter function, no
modifying keyed fields, ...) would be better placed in a separate section since
those prohibitions are universally applicable.
> Documentation about object reuse should be improved
> ---------------------------------------------------
>
> Key: FLINK-3333
> URL: https://issues.apache.org/jira/browse/FLINK-3333
> Project: Flink
> Issue Type: Bug
> Components: Documentation
> Affects Versions: 1.0.0
> Reporter: Gabor Gevay
> Assignee: Gabor Gevay
> Priority: Blocker
> Fix For: 1.0.0
>
>
> The documentation about object reuse \[1\] has several problems, see \[2\].
> \[1\]
> https://ci.apache.org/projects/flink/flink-docs-master/apis/batch/index.html#object-reuse-behavior
> \[2\]
> https://docs.google.com/document/d/1cgkuttvmj4jUonG7E2RdFVjKlfQDm_hE6gvFcgAfzXg/edit
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)
