[
https://issues.apache.org/jira/browse/BEAM-12223?focusedWorklogId=588671&page=com.atlassian.jira.plugin.system.issuetabpanels:worklog-tabpanel#worklog-588671
]
ASF GitHub Bot logged work on BEAM-12223:
-----------------------------------------
Author: ASF GitHub Bot
Created on: 26/Apr/21 03:46
Start Date: 26/Apr/21 03:46
Worklog Time Spent: 10m
Work Description: jrynd opened a new pull request #14642:
URL: https://github.com/apache/beam/pull/14642
The blank line in the example `private static class MyDataSourceProviderFn`
in the "Reading from JDBC datasource" causes javadoc to terminate prematurely.
While this is probably a bug in javadoc, it causes the documentation to be
missing everything after that spot -- including the rather important "how to
write to a JDBC datasource" section.. If you take out this line the javadoc
builds correctly. This bug was not in 2.23.0 but was in 2.24.0
I removed the blank line; this allows the doc to build correctly.
R: @turb
------------------------
Thank you for your contribution! Follow this checklist to help us
incorporate your contribution quickly and easily:
- [x] [**Choose
reviewer(s)**](https://beam.apache.org/contribute/#make-your-change) and
mention them in a comment (`R: @username`).
- [x] Format the pull request title like `[BEAM-XXX] Fixes bug in
ApproximateQuantiles`, where you replace `BEAM-XXX` with the appropriate JIRA
issue, if applicable. This will automatically link the pull request to the
issue.
- [ ] Update `CHANGES.md` with noteworthy changes.
- [ ] If this contribution is large, please file an Apache [Individual
Contributor License Agreement](https://www.apache.org/licenses/icla.pdf).
See the [Contributor Guide](https://beam.apache.org/contribute) for more
tips on [how to make review process
smoother](https://beam.apache.org/contribute/#make-reviewers-job-easier).
--
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: 588671)
Time Spent: 20m (was: 10m)
> Javadoc for JdbcIO is cut off
> -----------------------------
>
> Key: BEAM-12223
> URL: https://issues.apache.org/jira/browse/BEAM-12223
> Project: Beam
> Issue Type: Bug
> Components: examples-java, 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: 20m
> 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)
