[GitHub] beam pull request #2512: [BEAM-1949] Rename DoFn.Context#sideOutput to outpu...

[tgroh <gi...@git.apache.org>]

GitHub user tgroh opened a pull request:

    https://github.com/apache/beam/pull/2512

    [BEAM-1949] Rename DoFn.Context#sideOutput to output

    Be sure to do all of the following to help us incorporate your contribution
    quickly and easily:
    
     - [ ] Make sure the PR title is formatted like:
       `[BEAM-<Jira issue #>] Description of pull request`
     - [ ] Make sure tests pass via `mvn clean verify`. (Even better, enable
           Travis-CI on your fork and ensure the whole test matrix passes).
     - [ ] Replace `<Jira issue #>` in the title with the actual Jira issue
           number, if there is one.
     - [ ] If this contribution is large, please file an Apache
           [Individual Contributor License Agreement](https://www.apache.org/licenses/icla.pdf).
    
    ---
    Having two methods, both named output, one which takes the "main output type" and one that takes a tag to specify the type more clearly communicates the actual behavior - sideOutput isn't a "special" way to output, it's the same as output(T), just to a specified PCollection. This will help pipeline authors understand the actual behavior of outputting to a tag, and detangle it from "sideInput", which is a special way to receive input. Giving them the same name means that it's not even strange to call output and provide the main output type, which is what we want - it's a more specific way to output, but does not have different restrictions or capabilities.


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

    $ git pull https://github.com/tgroh/beam side_output_to_output

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

    https://github.com/apache/beam/pull/2512.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 #2512
    
----
commit 7e2f391f59236d0018d45973a12721b0328904a7
Author: Thomas Groh <tg...@google.com>
Date:   2017-04-11T00:14:15Z

    Rename DoFn.Context#sideOutput to output
    
    Having two methods, both named output, one which takes the "main output
    type" and one that takes a tag to specify the type more clearly
    communicates the actual behavior - sideOutput isn't a "special" way to
    output, it's the same as output(T), just to a specified PCollection.
    This will help pipeline authors understand the actual behavior of
    outputting to a tag, and detangle it from "sideInput", which is a
    special way to receive input. Giving them the same name means that it's
    not even strange to call output and provide the main output type, which
    is what we want - it's a more specific way to output, but does not have
    different restrictions or capabilities.

----


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---

[GitHub] beam pull request #2512: [BEAM-1949] Rename DoFn.Context#sideOutput to outpu...

[asfgit <gi...@git.apache.org>]

Github user asfgit closed the pull request at:

    https://github.com/apache/beam/pull/2512


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---