[jira] [Commented] (FLINK-4047) Fix documentation about determinism of KeySelectors

["ASF GitHub Bot (JIRA)" <ji...@apache.org>]

    [ https://issues.apache.org/jira/browse/FLINK-4047?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16158421#comment-16158421 ] 

ASF GitHub Bot commented on FLINK-4047:
---------------------------------------

GitHub user zhangminglei opened a pull request:

    https://github.com/apache/flink/pull/4659

    [FLINK-4047] Fix documentation about determinism of KeySelectors

    ## What is the purpose of the change
    
    This PR fixes the incorrect description for `KeySelectors`.
    
    ## Brief change log
    
      - Correct `api_concepts.md` file, make `arbitrary computations` to `deterministic computations`.
      - Update JavaDoc of `KeySelector `class
    
    ## Verifying this change
    
    This change is a trivial rework / code cleanup without any test coverage.

You can merge this pull request into a Git repository by running:

    $ git pull https://github.com/zhangminglei/flink flink-4047

Alternatively you can review and apply these changes as the patch at:

    https://github.com/apache/flink/pull/4659.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 #4659
    
----
commit ad54e76fd804c9ae18c5403872b5d3e26d51a266
Author: zhangminglei <zm...@163.com>
Date:   2017-09-08T10:04:28Z

    [FLINK-4047] Fix documentation about determinism of KeySelectors

----


> Fix documentation about determinism of KeySelectors
> ---------------------------------------------------
>
>                 Key: FLINK-4047
>                 URL: https://issues.apache.org/jira/browse/FLINK-4047
>             Project: Flink
>          Issue Type: Bug
>          Components: Documentation
>    Affects Versions: 1.1.0, 1.0.3
>            Reporter: Fabian Hueske
>            Priority: Blocker
>              Labels: starter
>             Fix For: 1.4.0
>
>
> KeySelectors must return deterministic keys, i.e., if invoked multiple times on the same object, the returned key must be the same.
> The documentation about this aspect is broken ("The key can be of any type and be derived from arbitrary computations.").
> We need to fix the JavaDocs of the {{KeySelector}} interface and the web documentation (https://ci.apache.org/projects/flink/flink-docs-master/apis/common/index.html#specifying-keys).



--
This message was sent by Atlassian JIRA
(v6.4.14#64029)