flink-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "ASF GitHub Bot (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (FLINK-8524) Incorrect JavaDoc in TypeExtractor.getBinaryOperatorReturnType
Date Tue, 30 Jan 2018 09:21:00 GMT

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

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

GitHub user florianschmidt1994 opened a pull request:

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

    [FLINK-8524][JavaDoc] Fix JavaDoc for TypeExtractor.getBinaryReturnType

    ## What is the purpose of the change
    Fix JavaDoc for TypeExtractor.getBinaryReturnType
    
    ## Brief change log
    The JavaDoc stated that the parameter `lambdaOutputTypeArgumentIndices` was a
    table of indices of the type argument specifying the *input type*, where it
    actually is a table of indices of the type argument specifying the *output
    type*. This is now fixed.
      
    ## Verifying this change
    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): 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


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

    $ git pull https://github.com/florianschmidt1994/flink fix-javadoc-of-typeextractor-getbinaryreturntype

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

    https://github.com/apache/flink/pull/5382.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 #5382
    
----
commit e0ca411c5dab45c6d094b07478191eb564ff4e19
Author: Florian Schmidt <florian.schmidt.1994@...>
Date:   2018-01-30T09:09:16Z

    [FLINK-8524] Fix TypeExtractor.getBinaryReturnType JavaDoc
    
    The JavaDoc stated that the parameter `lambdaOutputTypeArgumentIndices` was a
    table of indices of the type argument specifying the input type, where it
    actually is a table of indices of the type argument specifying the output
    type. This is now fixed.

----


> Incorrect JavaDoc in TypeExtractor.getBinaryOperatorReturnType
> --------------------------------------------------------------
>
>                 Key: FLINK-8524
>                 URL: https://issues.apache.org/jira/browse/FLINK-8524
>             Project: Flink
>          Issue Type: Bug
>          Components: Java API
>            Reporter: Florian Schmidt
>            Assignee: Florian Schmidt
>            Priority: Trivial
>
> The parameter _lambdaOutputTypeArgumentIndices_ in the JavaDoc of {code:java} TypeExtractor.getBinaryOperatorReturnType
{code}
> is described as a _Table of indices of the type argument specifying the *input* type.
See example._, whereas it actually describes the table of indices of the output type.



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

Mime
View raw message