Skip to content

Fix code comment in Druid and base JDBC client#12066

Merged
ebyhr merged 1 commit intotrinodb:masterfrom
polaris6:modify-the-javadoc
Apr 22, 2022
Merged

Fix code comment in Druid and base JDBC client#12066
ebyhr merged 1 commit intotrinodb:masterfrom
polaris6:modify-the-javadoc

Conversation

@polaris6
Copy link
Member

企业微信截图_4f8f9c9d-f3ce-4dd0-8080-ffaaf0eb5fb3

企业微信截图_08458a36-5c5a-4a79-bb65-cb074d610d2b

@cla-bot cla-bot bot added the cla-signed label Apr 21, 2022
Copy link
Member

@hashhar hashhar left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think these comments are javadoc since they are useful only for the people changing the class itself - not for people using the class. i.e. it's implementation detail.

@hashhar
Copy link
Member

hashhar commented Apr 21, 2022

Maybe we can convert to normal multi-line code comment instead.

@polaris6
Copy link
Member Author

polaris6 commented Apr 21, 2022

Maybe we can convert to normal multi-line code comment instead.

hi @hashhar, thank you for your suggestion. These comments contain @link, if you use a multi-line code comment, the @link will not take effect, this makes @link a little weird here.

Copy link
Member

@ebyhr ebyhr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please capitalize the commit title and remove commit body:

Fix code comment in Druid and base JDBC client

https://github.com/trinodb/trino/blob/master/.github/DEVELOPMENT.md#format-git-commit-messages

@polaris6 polaris6 force-pushed the modify-the-javadoc branch from f90ce07 to 4b7dc9f Compare April 22, 2022 05:20
@polaris6
Copy link
Member Author

hi @ebyhr, thank you for your suggestion, I resubmitted it.

@polaris6 polaris6 changed the title modify the javadoc in DruidJdbcClient Fix code comment in Druid and base JDBC client Apr 22, 2022
@ebyhr ebyhr added the no-release-notes This pull request does not require release notes entry label Apr 22, 2022
@ebyhr ebyhr merged commit 2707f33 into trinodb:master Apr 22, 2022
@github-actions github-actions bot added this to the 379 milestone Apr 22, 2022
@polaris6 polaris6 deleted the modify-the-javadoc branch April 25, 2022 06:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

cla-signed no-release-notes This pull request does not require release notes entry

Development

Successfully merging this pull request may close these issues.

3 participants