[jira] [Commented] (FLINK-1960) Add comments and docs for withForwardedFields and related operators

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

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

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

dmpalyvos opened a new pull request #6753: [FLINK-1960] [Documentation] Add docs for withForwardedFields and related operators in Scala API
URL: https://github.com/apache/flink/pull/6753
 
 
   ## What is the purpose of the change
   
   The withForwardedFields and related operators have no docs in the Scala API. This pull request adds  documentation (javadoc) for them.
   
   ## Brief change log
   
   *Added documentation for the `withForwardedFields*` Scala functions based on the javadoc of the related java functions*:
     - *Added documentation to withForwardedFields*
     - *Added documentation to withForwardedFieldsFirst*
     - *Added documentation to withForwardedFieldsSecond*
   
   ## Verifying this change
   
   This change is a trivial documentation update without any test coverage.
   
   ## 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? -
   

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


> Add comments and docs for withForwardedFields and related operators
> -------------------------------------------------------------------
>
>                 Key: FLINK-1960
>                 URL: https://issues.apache.org/jira/browse/FLINK-1960
>             Project: Flink
>          Issue Type: Improvement
>          Components: Documentation
>            Reporter: Theodore Vasiloudis
>            Assignee: hzhuangzhenxi
>            Priority: Minor
>              Labels: documentation, pull-request-available, starter
>
> The withForwardedFields and related operators have no docs for the Scala API. It would be useful to have code comments and example usage in the docs.



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