PTransform identifier(name) documentation in Java SDK.
- 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 Java SDK.
Specifically address this in Javadoc of `Pipeline#apply`, `PBegin#apply`, `PCollection#apply`, `Metrics`, `MetricsResult`, `MetricsFilter`.
Documentation around Metrics `step` (Which corresponds to the PTransform application identifier) in the classes mentioned above is a bit confusing currently, this should be reworded in correlation with the changes `Pipeline#apply`, `PBegin#apply`, `PCollection#apply`.
See parent issue BEAM-2035 for more information.
Imported from Jira [BEAM-2037](https://issues.apache.org/jira/browse/BEAM-2037). Original Jira may contain additional context.
Reported by: aviemzur.
Subtask of issue #18384
Contributor guide
Research direction
Start with the Javadocs for Pipeline#apply, PBegin#apply, PCollection#apply, Metrics, MetricsResult, and MetricsFilter. Use the parent issue BEAM-2035 for context, then align the explanations of PTransform application identifiers and Metrics step. Done means the listed Java SDK documentation is consistent and no longer confusing.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100