Skip to content

Commit 439b0d8

Browse files
sh-chospring-builds
authored andcommitted
Rephrase replication factor documentation (#3909)
* Fix docs on `RetryableTopic.replicationFactor()` * Rephrase replicationFactor description about broker version Signed-off-by: Seonghyeon Cho <seonghyeoncho96@gmail.com> (cherry picked from commit ec154a3)
1 parent be94a89 commit 439b0d8

File tree

2 files changed

+5
-5
lines changed

2 files changed

+5
-5
lines changed

spring-kafka/src/main/java/org/springframework/kafka/annotation/RetryableTopic.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -119,7 +119,7 @@
119119
/**
120120
* The replication factor for the automatically created topics. Expressions must
121121
* resolve to a short or a String that can be parsed as such. Default is -1 to use the
122-
* broker default if the broker is earlier than version 2.4, an explicit value is
122+
* broker default. If the broker is earlier than version 2.4, an explicit value is
123123
* required.
124124
*
125125
* @return the replication factor.

spring-kafka/src/main/java/org/springframework/kafka/retrytopic/RetryTopicConfigurationBuilder.java

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -428,8 +428,8 @@ public RetryTopicConfigurationBuilder doNotAutoCreateRetryTopics() {
428428
* Configure the topic creation behavior to auto create topics with the provided
429429
* properties.
430430
* @param numPartitions the number of partitions.
431-
* @param replicationFactor the replication factor (-1 to use the broker default if the
432-
* broker is version 2.4 or later).
431+
* @param replicationFactor the replication factor (-1 to use the broker default. If the
432+
* broker is earlier than version 2.4, an explicit value is required).
433433
* @return the builder.
434434
*/
435435
public RetryTopicConfigurationBuilder autoCreateTopicsWith(@Nullable Integer numPartitions, @Nullable Short replicationFactor) {
@@ -443,8 +443,8 @@ public RetryTopicConfigurationBuilder autoCreateTopicsWith(@Nullable Integer num
443443
* properties.
444444
* @param shouldCreate true to auto create.
445445
* @param numPartitions the number of partitions.
446-
* @param replicationFactor the replication factor (-1 to use the broker default if the
447-
* broker is version 2.4 or later).
446+
* @param replicationFactor the replication factor (-1 to use the broker default. If the
447+
* broker is earlier than version 2.4, an explicit value is required).
448448
* @return the builder.
449449
*/
450450
public RetryTopicConfigurationBuilder autoCreateTopics(@Nullable Boolean shouldCreate, @Nullable Integer numPartitions,

0 commit comments

Comments
 (0)