[BEAM-7408] Beam Programming Guide inconsistencies

• Type: Improvement
• Status: Resolved
• Priority: P2
• Resolution: Fixed
• Affects Version/s: Not applicable
• Fix Version/s: Not applicable
• Component/s: website
• Labels: documentation newbie
• Assignee: Unassigned
• Reporter: David Yan
• Created: 23/May/19 21:05
• Updated: 16/May/20 13:45
• Resolved: 05/Jun/19 20:15

Description

https://beam.apache.org/documentation/programming-guide/

 

Pipeline option example:

 

Examples in Java, Python and Go are not consistent. Java has myCustomOption, while Python and Go have "input" and "output".

 

When Python is chosen, the doc says --myCustomOption=value is supported, which only corresponds to the java example.

 

Reading from external source:

 

Java, Python and Go are not consistent. Python example reads from a GCS file, while others specify a generic file.

https://beam.apache.org/documentation/programming-guide/#applying-transforms: The last workflow graph does not correspond to the code example.

Issue Links

• links to: GitHub Pull Request #8670
• links to: GitHub Pull Request #8673