Polish documentation #42445
Closed
Polish documentation #42445
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
spring-projects-issues
added
the
status: waiting-for-triage
mhalbritter
reviewed
Sep 25, 2024
| @@ -165,7 +165,7 @@ spring: | |||
| [[data.sql.jdbc-template]] | |||
| == Using JdbcTemplate | |||
|
|
|||
| Spring's `JdbcTemplate` and `NamedParameterJdbcTemplate` classes are auto-configured, and you can `@Autowire` them directly into your own beans, as shown in the following example: | |||
There was a problem hiding this comment.
This is intentional. While the annotation is called @Autowired, we made a verb out of it, @Autowire.
Team: I think that's somewhat confusing. Maybe it's besser to change this to "and you can autowire them ..." ?
There was a problem hiding this comment.
+1 for changing to "autowire". The Framework docs use "autowire" as a verb and we should follow suit, particularly as the example that follows doesn't even use @Autowired as it does not need to do so.
| @@ -528,7 +528,7 @@ If you want to make sure that each context has a separate embedded database, you | |||
| [[data.sql.r2dbc.using-database-client]] | |||
| === Using DatabaseClient | |||
|
|
|||
| A `DatabaseClient` bean is auto-configured, and you can `@Autowire` it directly into your own beans, as shown in the following example: | |||
| @@ -176,7 +176,7 @@ If you need to start a full running server, we recommend that you use random por | |||
| If you use `@SpringBootTest(webEnvironment=WebEnvironment.RANDOM_PORT)`, an available port is picked at random each time your test runs. | |||
|
|
|||
| The `@LocalServerPort` annotation can be used to xref:how-to:webserver.adoc#howto.webserver.discover-port[inject the actual port used] into your test. | |||
| For convenience, tests that need to make REST calls to the started server can additionally `@Autowire` a {url-spring-framework-docs}/testing/webtestclient.html[`WebTestClient`], which resolves relative links to the running server and comes with a dedicated API for verifying responses, as shown in the following example: | |||
There was a problem hiding this comment.
The example needs @Autowired (so that the test context framework's parameter resolver kicks in) but I'm still in favor of using "autowire" here as well.
mhalbritter
added
type: documentation
|
Thanks @ngocnhan-tran1996 ! |
mhalbritter
removed
for: team-attention
# for free
to join this conversation on GitHub.
Already have an account?
# to comment
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.
No description provided.