[
https://issues.apache.org/jira/browse/BEAM-6679?focusedWorklogId=199281&page=com.atlassian.jira.plugin.system.issuetabpanels:worklog-tabpanel#worklog-199281
]
ASF GitHub Bot logged work on BEAM-6679:
----------------------------------------
Author: ASF GitHub Bot
Created on: 15/Feb/19 15:16
Start Date: 15/Feb/19 15:16
Worklog Time Spent: 10m
Work Description: jklukas commented on pull request #7852: [BEAM-6679]
Clean up GroupIntoBatches Javadoc
URL: https://github.com/apache/beam/pull/7852#discussion_r257273107
##########
File path:
sdks/java/core/src/main/java/org/apache/beam/sdk/transforms/GroupIntoBatches.java
##########
@@ -48,25 +48,24 @@
* are output to the output {@link PCollection}.
*
* <p>Windows are preserved (batches contain elements from the same window).
Batches may contain
- * elements from more than one bundle
+ * elements from more than one bundle.
*
- * <p>Example (batch call a webservice and get return codes)
+ * <p>Example (batch call a webservice and get return codes):
*
* <pre>{@code
Review comment:
The combination of `<pre>` for preserving line breaks and `{@code` for
preserving angle brackets and curly brackets _mostly_ works.
`@` is the problematic character. I see `{@literal @}` show up in many
classes' Javadoc, and that method doesn't do what's intended. In current Java 8
builds, it looks like `@` inside `{@code}` is not a problem in the general case
and doesn't need to be escaped. The one exception is when `@` is the first
non-whitespace character in a line, in which case it appears that Javadoc
thinks it's a tag like `@return` or `@param` and throws an error.
I propose a solution for that case below.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
[email protected]
Issue Time Tracking
-------------------
Worklog Id: (was: 199281)
Time Spent: 40m (was: 0.5h)
> Clean up GroupIntoBatches Javadoc
> ---------------------------------
>
> Key: BEAM-6679
> URL: https://issues.apache.org/jira/browse/BEAM-6679
> Project: Beam
> Issue Type: Bug
> Components: sdk-java-core
> Reporter: Jeff Klukas
> Assignee: Jeff Klukas
> Priority: Minor
> Time Spent: 40m
> Remaining Estimate: 0h
>
> [The current Javadoc for
> GroupIntoBatches|https://beam.apache.org/releases/javadoc/2.10.0/org/apache/beam/sdk/transforms/GroupIntoBatches.html]
> is strangely formatted, making it difficult to understand the code example
> and learn how to use the transform.
> The code example should also follow conventions from classes like MapElements
> where the code example assumes a PCollection of some type and demonstrates
> the output PCollection type after applying the transform.
--
This message was sent by Atlassian JIRA
(v7.6.3#76005)
