beam-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Ahmet Altay (JIRA)" <>
Subject [jira] [Resolved] (BEAM-536) More misleading documentation. More bad documentation
Date Mon, 20 Mar 2017 22:50:41 GMT


Ahmet Altay resolved BEAM-536.
       Resolution: Fixed
    Fix Version/s: Not applicable

>  More misleading documentation.  More bad documentation
> ----------------------------------------------------------------------
>                 Key: BEAM-536
>                 URL:
>             Project: Beam
>          Issue Type: Bug
>          Components: sdk-py
>            Reporter: Frank Yellin
>            Priority: Minor
>             Fix For: Not applicable
> The last paragraph of the documentation for Aggregator is:
> You can also query the combined value(s) of an aggregator by calling
> aggregated_value() or aggregated_values() on the result object returned after
> running a pipeline.
> There are multiple problems in this one sentence!
> #1) There is no such method aggregated_value() that I can find anywhere.
> #2) DirectRunner implements aggregated_values(), but DirectPipelineRunner does not. 
The latter is the far more interesting case.
> #3) When I use a BlockingDirectPipelineRunner and ask for its aggregated_values(), I
get an error message indicating that this is not implemented in DirectPipelineRunner.  Very
confusing since I never asked for a DirectPipelineRunner.
> It is clear that this is because BlockingDirectPipelineRunner is a method rather than
a class.  Is this really the right thing?  Will there be other confusing error messages.
> #4) The documentation for aggregated_values() says "returns a dict of step names to values
of the aggregator."  I have no idea what a "step" means in this context.  In practice, it
seems to be a single-element dictionary whose key is 'user--' prefixed onto the aggregator

This message was sent by Atlassian JIRA

View raw message