[
https://issues.apache.org/jira/browse/BEAM-2037?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Aviem Zur updated BEAM-2037:
----------------------------
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.
was:
Add 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.
> PTransform identifier(name) documentation in Java SDK.
> ------------------------------------------------------
>
> Key: BEAM-2037
> URL: https://issues.apache.org/jira/browse/BEAM-2037
> Project: Beam
> Issue Type: Sub-task
> Components: sdk-java-core
> Reporter: Aviem Zur
> Assignee: Davor Bonaci
>
> 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.
--
This message was sent by Atlassian JIRA
(v6.3.15#6346)
