apache/beam

Section 6.6 of the Apache Beam Python programming guide lacks examples

Open

#21,022 opened on Jun 4, 2022

View on GitHub
 (4 comments) (1 reaction) (1 assignee)Java (4,097 forks)batch import
P3bugexamplesgood first issuepythonwebsite

Repository metrics

Stars
 (7,313 stars)
PR merge metrics
 (Avg merge 6d) (243 merged PRs in 30d)

Description

In the section "Using Schema Transforms" of the Python programming guide, which can be found here, there are missing examples. e.g.

Nested fields

Individual nested fields can be specified using the dot operator. For example, to select just the postal code from the shipping address one would write

Wildcards

The * operator can be specified at any nesting level to represent all fields at that level. For example, to select all shipping-address fields one would write

These paragraphs are eerily similar to the ones that can be found on the Java programming guide, but they have their corresponding examples.

Imported from Jira BEAM-12825. Original Jira may contain additional context. Reported by: edusan.

Contributor guide

Research direction
Look at the Java programming guide for analogous examples and add them to the Python guide in the corresponding sections.
Tech stack
python
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85