cosmetic doc improvements for jdbc component #2148
Closed
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
Signed-off-by: Nathan Xu <nathan.qinghyang.xu@gmail.com>
NathanQingyangXu
force-pushed
the
cosmetic-doc-improvements-jdbc
branch
from
e9f297d to
b3e6c63
Compare
spring-projects-issues
added
the
status: waiting-for-triage
NathanQingyangXu
changed the title
NathanQingyangXu
commented
Oct 4, 2025
| + You can let Spring auto-discover your javadoc:org.springframework.data.jdbc.core.dialect.JdbcDialect[] by registering a class that implements `org.springframework.data.jdbc.core.dialect.DialectResolver$JdbcDialectProvider` through `META-INF/spring.factories`. | ||
| Dialects are resolved by javadoc:org.springframework.data.jdbc.core.dialect.DialectResolver[] from a `JdbcOperations` instance, typically by inspecting `Connection.getMetaData()`. + | ||
| You can let Spring auto-discover your javadoc:org.springframework.data.jdbc.core.dialect.JdbcDialect[] by registering a class that implements `org.springframework.data.jdbc.core.dialect.DialectResolver$JdbcDialectProvider` through `META-INF/spring.factories`. | ||
| `DialectResolver` discovers dialect provider implementations from the class path using Spring's `SpringFactoriesLoader`. |
There was a problem hiding this comment.
I assume the intention was to insert a hard line break here. Currently, a literal "+" is displayed in the resulting doc instead.
NathanQingyangXu
commented
Oct 4, 2025
| The query you provide must match the format the `RowMapper` expects. | ||
| Columns for all properties that are used in the constructor of an entity must be provided. | ||
| Columns for properties that get set via setter, wither or field access are optional. | ||
| Columns for properties that get set via setter or field access are optional. |
There was a problem hiding this comment.
I am not sure about the wither, though I am almost sure it is a typo or defect, so I simply deleted it.
There was a problem hiding this comment.
It's not a typo. A "Wither" is similar to a getter but for immutable objects which returns an object wich is a copy of the original one but with a single property changed.
Something like
record Person(String first, String last) {
Person withLast(String last) {
return new Person (this.first, last);
}
}
mp911de
added
type: documentation
schauder
pushed a commit
that referenced
this pull request
Oct 21, 2025
Fixes various typos and similar. Signed-off-by: Nathan Xu <nathan.qinghyang.xu@gmail.com> Original pull request #2148
schauder
added a commit
that referenced
this pull request
Oct 21, 2025
Undo removal of "withers". Original pull request #2148
schauder
pushed a commit
that referenced
this pull request
Oct 21, 2025
Fixes various typos and similar. Signed-off-by: Nathan Xu <nathan.qinghyang.xu@gmail.com> Original pull request #2148
schauder
added a commit
that referenced
this pull request
Oct 21, 2025
Undo removal of "withers". Original pull request #2148
schauder
pushed a commit
that referenced
this pull request
Oct 21, 2025
Fixes various typos and similar. Signed-off-by: Nathan Xu <nathan.qinghyang.xu@gmail.com> Original pull request #2148
schauder
added a commit
that referenced
this pull request
Oct 21, 2025
Undo removal of "withers". Original pull request #2148
|
Except for the single change regarding "wither" this is merged. Thanks for the contribution. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 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.
Seems the doc has room for improvement. This PR tries to correct some obvious defects and is only restricted to Spring Data JDBC module. Further follow-up PRs might be created in the future.