apache / apache/beam

PTransform identifier(name) documentation in Python SDK.

Open
#18,386 0 comments 0 reactions 0 assignees View on GitHub
core P3 python sub-task
Dominant language
Java
Stars
8.7k
Forks
4.7k
Avg merge
2d 2h
Merged PRs (30d)
205

Description

Add/improve PTransform identifier(name) documentation in Python SDK.

Specifically address this in in documentation of application of a `PTransform` in the pipeline and in code pertaining to metrics.

See parent issue BEAM-2035 for more information.
Take a look at the Java SDK subtask as well: BEAM-2037. Ideas from that subtask can be applied here.

Imported from Jira [BEAM-2038](https://issues.apache.org/jira/browse/BEAM-2038). Original Jira may contain additional context.
Reported by: aviemzur.
Subtask of issue #18384

Contributor guide

Open the contributing guide

Research direction

Start by reviewing the Python SDK documentation for applying a PTransform in a pipeline and the Python code pertaining to metrics. Read parent issue BEAM-2035 and the Java SDK subtask BEAM-2037 for context and related ideas. Done means the Python SDK clearly documents PTransform identifier(name) in both requested areas.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.