[
https://issues.apache.org/jira/browse/BEAM-12223?focusedWorklogId=591404&page=com.atlassian.jira.plugin.system.issuetabpanels:worklog-tabpanel#worklog-591404
]
ASF GitHub Bot logged work on BEAM-12223:
-----------------------------------------
Author: ASF GitHub Bot
Created on: 30/Apr/21 08:46
Start Date: 30/Apr/21 08:46
Worklog Time Spent: 10m
Work Description: aromanenko-dev edited a comment on pull request #14642:
URL: https://github.com/apache/beam/pull/14642#issuecomment-829943261
> Do the other instances of `<pre>{@code` need to get changed to
`<pre><code>`?
No only if they don't contain any characters that have to be escaped (like,
`@`, `<` and `>`). In this case, one of the option is to escape them with
`{@literal ... }` and then we need to switch to `<pre><code>`.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to 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: 591404)
Time Spent: 1h 50m (was: 1h 40m)
> Javadoc for JdbcIO is cut off
> -----------------------------
>
> Key: BEAM-12223
> URL: https://issues.apache.org/jira/browse/BEAM-12223
> Project: Beam
> Issue Type: Bug
> Components: io-java-jdbc
> Affects Versions: 2.24.0, 2.25.0, 2.26.0, 2.27.0, 2.28.0
> Environment: web browser
> Reporter: Jonathan Rynd
> Priority: P2
> Labels: documentation
> Time Spent: 1h 50m
> Remaining Estimate: 0h
>
> Looking at the JdbcIO documentation, for instance
> [https://beam.apache.org/releases/javadoc/2.28.0/org/apache/beam/sdk/io/jdbc/JdbcIO.html
>
> |https://beam.apache.org/releases/javadoc/2.28.0/org/apache/beam/sdk/io/jdbc/JdbcIO.html],
> we can clearly see that the documentation gets cut off in the middle of a
> code sample. The rest of the documentation in the javadoc comment is missing;
> it goes right to the nested class summary. I believe this is because of a
> blank line that was added to the code for readability purposes; this confuses
> javadoc.
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
