improve some JDBC related Javadocs #9195
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
NathanQingyangXu
commented
Nov 3, 2024
| * Models size restrictions/requirements on a column's data type. | ||
| * | ||
| * @implNote Since we do not necessarily know the datatype up front, and therefore do not necessarily know | ||
| * @implNote Since we do not necessarily know the data type up front, and therefore do not necessarily know |
Contributor
Author
There was a problem hiding this comment.
found data type usage elsewhere so change to make it more consistent
NathanQingyangXu
force-pushed
the
improve-javadoc-jdbc-related
branch
from
aae43e0 to
762a1bf
Compare
gavinking
approved these changes
Nov 4, 2024
hibernate-core/src/main/java/org/hibernate/engine/jdbc/Size.java
Outdated
Show resolved
Hide resolved
...in/java/org/hibernate/engine/jdbc/connections/spi/AbstractMultiTenantConnectionProvider.java
Outdated
Show resolved
Hide resolved
...-core/src/main/java/org/hibernate/engine/jdbc/cursor/internal/RefCursorSupportInitiator.java
Outdated
Show resolved
Hide resolved
...te-core/src/main/java/org/hibernate/resource/jdbc/internal/ResourceRegistryStandardImpl.java
Outdated
Show resolved
Hide resolved
...te-core/src/main/java/org/hibernate/resource/jdbc/internal/ResourceRegistryStandardImpl.java
Outdated
Show resolved
Hide resolved
Contributor
Author
|
@gavinking , I accepted your suggestions. Thanks for the excellent suggestions. |
NathanQingyangXu
force-pushed
the
improve-javadoc-jdbc-related
branch
from
9a56883 to
4f31630
Compare
gavinking
approved these changes
Nov 7, 2024
gavinking
reviewed
Nov 7, 2024
Member
There was a problem hiding this comment.
@NathanQingyangXu One more very minor thing: I generally try to avoid adding imports just for types used only in the javadoc.
Maybe that's silly, but it's what I've been doing.
...core/src/main/java/org/hibernate/engine/jdbc/mutation/internal/MutationExecutorStandard.java
Outdated
Show resolved
Hide resolved
...core/src/main/java/org/hibernate/engine/jdbc/mutation/internal/MutationExecutorStandard.java
Outdated
Show resolved
Hide resolved
Contributor
Author
that is a good point. I changed and pushed, but only later on I found your commit suggestion. |
gavinking
approved these changes
Nov 8, 2024
Member
|
Thanks, @NathanQingyangXu ! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license
and can be relicensed under the terms of the LGPL v2.1 license in the future at the maintainers' discretion.
For more information on licensing, please check here.
Recently I am working on JDBC related stuff in MongoDB company. I found some (super) minor issues in our Javadocs JDBC related, including:
{@link xxx}which would help end user to navigate