[jira] [Created] (BEAM-1695) Improve Python-SDK's programming guide

["Tibor Kiss (JIRA)" <ji...@apache.org>]

Tibor Kiss created BEAM-1695:
--------------------------------

             Summary: Improve Python-SDK's programming guide
                 Key: BEAM-1695
                 URL: https://issues.apache.org/jira/browse/BEAM-1695
             Project: Beam
          Issue Type: Bug
          Components: website
            Reporter: Tibor Kiss
            Priority: Minor


Beam's programming guide provides a tutorial-like structure to introduce the user to the main concepts.

Due to flaws of the snippets the copied code needs altering to work.
Some of the problems per section
1) Section "Creating the pipeline"
    - {{import apache_beam as beam}} statement is missing from the beginning
    - The command line arguments are not parsed
2) Section "Creating a PCollection from in-memory data"
    - {{pipeline_options}} variable is undefined
    - {{my_options}} variable is undefined
3) Section "ParDo": 
    - It is not explained how to define {{words}} variable
4) Section "Advanced combinations using CombineFn" and "Combining a PCollection into a single value" has the same code snippet
5) Section "Combining values in a key-grouped collection":
   - It is not explained how to define {{player_accuracies}}
6) Section "Using Flatten and Partition"
   - The code snippet contains unnecessary markers ({{[START model_multiple_pcollections_tuple]}})
7) Section "partition":
   - {{students}} variable is undefined

This list might not be complete.

The website's repo is located at: https://github.com/apache/beam-site
The snippets are taken from: https://github.com/apache/beam/blob/master/sdks/python/apache_beam/examples/snippets/snippets.py





--
This message was sent by Atlassian JIRA
(v6.3.15#6346)