[
https://issues.apache.org/jira/browse/FLINK-3333?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15139219#comment-15139219
]
Gabor Gevay commented on FLINK-3333:
------------------------------------
OK, this would also be a clear improvement over the current documentation.
However, this doesn't discuss the rules about whether I can modify output
objects after returning them. This question is far from being trivial (as
evidenced by the comment thread in the Google Doc). Do you think that this
"edge case" is too insignificant to mention?
> 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.
This is why I think that the separation between the non-chained/chained cases
should be left out of this. If we are aiming for simplicity here, then I really
can't imagine a user meticulously checking whether his operator will be
chained, and then writing different code based on this.
Other minor issues:
> In practice that means that a user function will always receive the same
> object instance
"it can happen that" should be inserted. See point C) in the "Concrete problems
with the current documentation" section in the Google Doc.
> User defined functions (like map() or groupReduce())
Should be "like MapFunction or GroupReduceFunction", to avoid confusing new
users about what is a user defined function.
> 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)
