[jira] [Commented] (FLINK-9299) ProcessWindowFunction documentation Java examples have errors

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

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

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

GitHub user medcv opened a pull request:

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

    [FLINK-9299] [Documents] ProcessWindowFunction documentation Java examples have error

    
    ## What is the purpose of the change
    
    ProcessWindowFunction documentation Java examples have error
    
    ## Brief change log
    
    ProcessWindowFunction is an abstract class and should extends instead of implements 
    
    ## Does this pull request potentially affect one of the following parts:
    
      - Dependencies (does it add or upgrade a dependency): (no)
      - The public API, i.e., is any changed class annotated with `@Public(Evolving)`: (no)
      - The serializers: (no)
      - The runtime per-record code paths (performance sensitive): (no)
      - Anything that affects deployment or recovery: JobManager (and its components), Checkpointing, Yarn/Mesos, ZooKeeper: (no)
      - The S3 file system connector: (no)
    
    ## Documentation
    
      - Does this pull request introduce a new feature? (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/medcv/flink patch-5

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

    https://github.com/apache/flink/pull/6000.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 #6000
    
----
commit aa26f9a08c5938eae31833a73e42e82cb213e59f
Author: Yazdan.JS <y_...@...>
Date:   2018-05-13T05:40:39Z

    [FLINK-9299] ProcessWindowFunction documentation Java examples have errors

----


> ProcessWindowFunction documentation Java examples have errors
> -------------------------------------------------------------
>
>                 Key: FLINK-9299
>                 URL: https://issues.apache.org/jira/browse/FLINK-9299
>             Project: Flink
>          Issue Type: Bug
>          Components: Documentation
>    Affects Versions: 1.4.2
>            Reporter: Ken Krugler
>            Assignee: vinoyang
>            Priority: Minor
>
> In looking at [https://ci.apache.org/projects/flink/flink-docs-release-1.4/dev/stream/operators/windows.html#processwindowfunction-with-incremental-aggregation], I noticed a few errors...
>  * "This allows to incrementally compute windows" should be "This allows it to incrementally compute windows"
>  * DataStream<Tuple2<String, Long> input = ...; should be DataStream<Tuple2<String, Long>> input = ...;
>  * The getResult() method needs to cast one of the accumulator values to a double, if that's what it is going to return.
>  * MyProcessWindowFunction needs to extend, not implement ProcessWindowFunction
>  * MyProcessWindowFunction needs to implement a process() method, not an apply() method.
>  * The call to .timeWindow takes a Time parameter, not a window assigner.
>  



--
This message was sent by Atlassian JIRA
(v7.6.3#76005)