[jira] [Closed] (BEAM-556) typo in documentation

2016-10-12 Thread Frank Yellin (JIRA)

 [ 
https://issues.apache.org/jira/browse/BEAM-556?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
 ]

Frank Yellin closed BEAM-556.
-
   Resolution: Fixed
Fix Version/s: 0.3.0-incubating

> typo in documentation
> -
>
> Key: BEAM-556
> URL: https://issues.apache.org/jira/browse/BEAM-556
> Project: Beam
>  Issue Type: Bug
>  Components: sdk-py
>Reporter: Frank Yellin
>Assignee: Frank Yellin
>Priority: Trivial
> Fix For: 0.3.0-incubating
>
>   Original Estimate: 2m
>  Remaining Estimate: 2m
>
> transform.py:
> ergument -> argument  
> in documentation for parse_label_and_args



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)


[jira] [Created] (BEAM-536) Aggregator.py. More misleading documentation. More bad documentation

2016-08-05 Thread Frank Yellin (JIRA)
Frank Yellin created BEAM-536:
-

 Summary: Aggregator.py.  More misleading documentation.  More bad 
documentation
 Key: BEAM-536
 URL: https://issues.apache.org/jira/browse/BEAM-536
 Project: Beam
  Issue Type: Bug
Reporter: Frank Yellin
Priority: Minor


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 name.  



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)


[jira] [Created] (BEAM-524) Description of "type" argument in Aggregator is incorrect

2016-08-03 Thread Frank Yellin (JIRA)
Frank Yellin created BEAM-524:
-

 Summary: Description of "type" argument in Aggregator is incorrect
 Key: BEAM-524
 URL: https://issues.apache.org/jira/browse/BEAM-524
 Project: Beam
  Issue Type: Bug
Reporter: Frank Yellin
Priority: Minor


Two problems with documentation for "type" argument.

Trivial:  Remove "by default".  This phrase implies that there are other 
alternatives besides what is listed.  There aren't.

Non trivial.  The documentation says "types appropriate to the combine_fn" are 
accepted.  I tried 
Accumulator("foo", max, datetime.datetime)
This failed even though "datetime.datetime" is a perfectly reasonable type to 
want to take the max of.  (I wanted to know precisely when the last job 
finished.)

Either the documentation needs to be changed to specify that max/min only apply 
to numeric types, or the code needs to be changed to allow other uses of min 
and max.




--
This message was sent by Atlassian JIRA
(v6.3.4#6332)


[jira] [Created] (BEAM-523) Minor typo in aggregator_test.py

2016-08-03 Thread Frank Yellin (JIRA)
Frank Yellin created BEAM-523:
-

 Summary: Minor typo in aggregator_test.py
 Key: BEAM-523
 URL: https://issues.apache.org/jira/browse/BEAM-523
 Project: Beam
  Issue Type: Bug
  Components: beam-model
Reporter: Frank Yellin
Assignee: Frances Perry
Priority: Trivial


aggregators is repeatedly misspelled as aggeregators.



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)