[jira] [Commented] (BEAM-1957) Missing DoFn annotations documentation

["Kenneth Knowles (JIRA)" <ji...@apache.org>]

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

Kenneth Knowles commented on BEAM-1957:
---------------------------------------

Yes, we also need to cover all the state and timers APIs. I think updates to the guide should be coordinated with [~melap] who might know what is already in the works.

> Missing DoFn annotations documentation
> --------------------------------------
>
>                 Key: BEAM-1957
>                 URL: https://issues.apache.org/jira/browse/BEAM-1957
>             Project: Beam
>          Issue Type: Improvement
>          Components: website
>            Reporter: Aviem Zur
>
> Not all {{DoFn}} annotations are covered by the programming guide.
> Only {{@ProcessElement}} is currently covered.
> We should have documentation for the other (non-expermintal at least) annotations:
> {code}
> public @interface Setup
> public @interface StartBundle
> public @interface FinishBundle
> public @interface Teardown
> {code}



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