[jira] [Commented] (FLINK-7234) Fix CombineHint documentation

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

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

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

GitHub user greghogan opened a pull request:

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

    [FLINK-7234] [docs] Fix CombineHint documentation

    ## What is the purpose of the change
    
    Update and correct the documentation for the use of CombineHint with `reduce` or `distinct`. The documentation for 1.2/1.3/1.4 has CombineHint described under `groupReduce`.
    
    ## Brief change log
    
    Documentation was moved and slightly reworded.
    
    This change is a trivial rework / code cleanup without any test coverage.
    
    ## Does this pull request potentially affect one of the following parts:
    
    Dependencies (does it add or upgrade a dependency): (yes / **no**)
    The public API, i.e., is any changed class annotated with @Public(Evolving): (yes / **no**)
    The serializers: (yes / **no** / don't know)
    The runtime per-record code paths (performance sensitive): (yes / **no** / don't know)
    Anything that affects deployment or recovery: JobManager (and its components), Checkpointing, Yarn/Mesos, ZooKeeper: (yes / **no** / don't know):
    
    ## Documentation
    
    Does this pull request introduce a new feature? (yes / **no**)
    If yes, how is the feature documented? (not applicable / **docs** / JavaDocs / not documented)

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

    $ git pull https://github.com/greghogan/flink 7234_fix_combinehint_documentation

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

    https://github.com/apache/flink/pull/4372.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 #4372
    
----
commit ec143c7ad08a47de96b418878efd540ec7328636
Author: Greg Hogan <co...@greghogan.com>
Date:   2017-07-19T19:24:20Z

    [FLINK-7234] [docs] Fix CombineHint documentation
    
    The CombineHint documentation applies to DataSet#reduce not
    DataSet#reduceGroup and should also be note for DataSet#distinct. It is
    also set with .setCombineHint(CombineHint) rather than alongside the UDF
    parameter.

----


> Fix CombineHint documentation
> -----------------------------
>
>                 Key: FLINK-7234
>                 URL: https://issues.apache.org/jira/browse/FLINK-7234
>             Project: Flink
>          Issue Type: Bug
>          Components: Documentation
>    Affects Versions: 1.2.2, 1.4.0, 1.3.2
>            Reporter: Greg Hogan
>            Assignee: Greg Hogan
>
> The {{CombineHint}} [documentation|https://ci.apache.org/projects/flink/flink-docs-release-1.4/dev/batch/index.html] applies to {{DataSet#reduce}} not {{DataSet#reduceGroup}} and should also be note for {{DataSet#distinct}}. It is also set with {{.setCombineHint(CombineHint)}} rather than alongside the UDF parameter.



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