You are viewing a plain text version of this content. The canonical link for it is here.
Posted to jira@kafka.apache.org by "stantheman0128 (via GitHub)" <gi...@apache.org> on 2026/08/07 15:51:05 UTC
[PR] MINOR: Fix invalid {@param} Javadoc tags in streams and connect [kafka]
stantheman0128 opened a new pull request, #23113:
URL: https://github.com/apache/kafka/pull/23113
Several Javadoc comments in streams and connect/runtime use {@param x},
which is not a valid Javadoc tag. Replace them with {@code x}, the
convention already used elsewhere in these same comments.
Also fixes RackAwareTaskAssignor#validateClientRack: the doc referenced
racksForProcess, but the actual parameter is named rackForProcess.
Verified with:
./gradlew :streams:javadoc :connect:runtime:javadoc spotlessCheck
Co-Authored-By: Claude Sonnet 5 <cl...@anthropic.com>
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: jira-unsubscribe@kafka.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] MINOR: Fix invalid {@param} Javadoc tags in streams and connect [kafka]
Posted by "uros-b (via GitHub)" <gi...@apache.org>.
uros-b commented on PR #23113:
URL: https://github.com/apache/kafka/pull/23113#issuecomment-5304295820
Nice, thank you @stantheman0128!
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: jira-unsubscribe@kafka.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] MINOR: Fix invalid {@param} Javadoc tags in streams and connect [kafka]
Posted by "stantheman0128 (via GitHub)" <gi...@apache.org>.
stantheman0128 commented on PR #23113:
URL: https://github.com/apache/kafka/pull/23113#issuecomment-5840674659
@chia7712 could you take a look when you get a chance? uros-b approved it on Aug 15.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: jira-unsubscribe@kafka.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] MINOR: Fix invalid {@param} Javadoc tags in streams and connect [kafka]
Posted by "stantheman0128 (via GitHub)" <gi...@apache.org>.
stantheman0128 commented on code in PR #23113:
URL: https://github.com/apache/kafka/pull/23113#discussion_r4259891911
##########
streams/src/main/java/org/apache/kafka/streams/processor/assignment/TaskAssignmentUtils.java:
##########
@@ -628,7 +628,7 @@ boolean canMoveStandbyTask(final KafkaStreamsState source,
/**
*
- * @return the traffic cost of assigning this {@param task} to the client {@param streamsState}.
+ * @return the traffic cost of assigning this {@code task} to the client {@code streamsState}.
Review Comment:
Right, the matching parameters are `topicPartitions` and `clientRack`. Fixed in 6b98cf9, together with `validateTopicPartitionRack`, whose doc called the field `racksForPartition` a parameter.
251ce9f fixes more doc errors in the same two files: three `@{code trafficCost}` typos, and the `@return` of `canPerformRackAwareOptimization`, which said the opposite of what the method returns. I can move that commit to a separate PR if you prefer.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: jira-unsubscribe@kafka.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] MINOR: Fix invalid {@param} Javadoc tags in streams and connect [kafka]
Posted by "chia7712 (via GitHub)" <gi...@apache.org>.
chia7712 commented on code in PR #23113:
URL: https://github.com/apache/kafka/pull/23113#discussion_r4109490450
##########
streams/src/main/java/org/apache/kafka/streams/processor/assignment/TaskAssignmentUtils.java:
##########
@@ -628,7 +628,7 @@ boolean canMoveStandbyTask(final KafkaStreamsState source,
/**
*
- * @return the traffic cost of assigning this {@param task} to the client {@param streamsState}.
+ * @return the traffic cost of assigning this {@code task} to the client {@code streamsState}.
Review Comment:
What should be modified is the parameter name, right? For exampel: `task` -> `topicPartitions`
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: jira-unsubscribe@kafka.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org