[jira] [Created] (FLINK-20312) The documentation is incomplete

classic Classic list List threaded Threaded
1 message Options
Reply | Threaded
Open this post in threaded view
|

[jira] [Created] (FLINK-20312) The documentation is incomplete

Shang Yuanchun (Jira)
sxb created FLINK-20312:
---------------------------

             Summary: The documentation is incomplete
                 Key: FLINK-20312
                 URL: https://issues.apache.org/jira/browse/FLINK-20312
             Project: Flink
          Issue Type: Improvement
          Components: Documentation
    Affects Versions: 1.11.0
            Reporter: sxb


In this [document|https://github.com/apache/flink/blob/master/docs/dev/stream/operators/windows.md], Under Triggers, TriggerResult's action is incomplete

 The description of PURGE is missing after and,As follows.

 

1) The first three decide how to act on their invocation event by returning a {{TriggerResult}}. The action can be one of the following:
 * {{CONTINUE}}: do nothing,
 * {{FIRE}}: trigger the computation,
 * {{PURGE}}: clear the elements in the window, {color:#FF0000}and{color}
 * {{FIRE_AND_PURGE}}: trigger the computation and clear the elements in the window afterwards.

 

Description in the source code

/**
 * All elements in the window are cleared and the window is discarded,
 * without evaluating the window function or emitting any elements.
 */
PURGE(false, true);



--
This message was sent by Atlassian Jira
(v8.3.4#803005)