You are viewing a plain text version of this content. The canonical link for it is here.
Posted to jira@kafka.apache.org by "mimaison (via GitHub)" <gi...@apache.org> on 2023/02/13 11:24:56 UTC
[GitHub] [kafka] mimaison opened a new pull request, #13239: MINOR: Various cleanups in clients javadoc
mimaison opened a new pull request, #13239:
URL: https://github.com/apache/kafka/pull/13239
### Committer Checklist (excluded from commit message)
- [ ] Verify design and implementation
- [ ] Verify test coverage and CI build status
- [ ] Verify documentation (including upgrade notes)
--
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
[GitHub] [kafka] showuon commented on a diff in pull request #13239: MINOR: Various cleanups in clients javadoc
Posted by "showuon (via GitHub)" <gi...@apache.org>.
showuon commented on code in PR #13239:
URL: https://github.com/apache/kafka/pull/13239#discussion_r1105504621
##########
clients/src/main/java/org/apache/kafka/common/KafkaFuture.java:
##########
@@ -127,8 +127,6 @@ public static KafkaFuture<Void> allOf(KafkaFuture<?>... futures) {
public abstract <R> KafkaFuture<R> thenApply(BaseFunction<T, R> function);
/**
- * @see KafkaFuture#thenApply(BaseFunction)
Review Comment:
Why did we link to itself? Interesting
##########
clients/src/main/java/org/apache/kafka/clients/producer/Partitioner.java:
##########
@@ -44,14 +44,15 @@ public interface Partitioner extends Configurable, Closeable {
void close();
/**
- * Note this method is only implemented in DefatultPartitioner and UniformStickyPartitioner which
- * are now deprecated. See KIP-794 for more info.
- *
+ * Note this method is only implemented in DefaultPartitioner and {@link UniformStickyPartitioner} which
+ * are now deprecated. See <a href="https://cwiki.apache.org/confluence/display/KAFKA/KIP-794%3A+Strictly+Uniform+Sticky+Partitioner">KIP-794</a> for more info.
+ * <p>
* Notifies the partitioner a new batch is about to be created. When using the sticky partitioner,
* this method can change the chosen sticky partition for the new batch.
* @param topic The topic name
* @param cluster The current cluster metadata
* @param prevPartition The partition previously selected for the record that triggered a new batch
+ * @deprecated Since 3.3.0
Review Comment:
nice catch!
--
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
[GitHub] [kafka] mimaison commented on a diff in pull request #13239: MINOR: Various cleanups in clients javadoc
Posted by "mimaison (via GitHub)" <gi...@apache.org>.
mimaison commented on code in PR #13239:
URL: https://github.com/apache/kafka/pull/13239#discussion_r1104339703
##########
clients/src/main/java/org/apache/kafka/clients/producer/Partitioner.java:
##########
@@ -44,14 +44,15 @@ public interface Partitioner extends Configurable, Closeable {
void close();
/**
- * Note this method is only implemented in DefatultPartitioner and UniformStickyPartitioner which
- * are now deprecated. See KIP-794 for more info.
- *
+ * Note this method is only implemented in DefaultPartitioner and {@link UniformStickyPartitioner} which
Review Comment:
I did not link `DefaultPartitioner` since it's not part of the public API
--
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
[GitHub] [kafka] mimaison merged pull request #13239: MINOR: Various cleanups in clients javadoc
Posted by "mimaison (via GitHub)" <gi...@apache.org>.
mimaison merged PR #13239:
URL: https://github.com/apache/kafka/pull/13239
--
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
[GitHub] [kafka] mimaison commented on a diff in pull request #13239: MINOR: Various cleanups in clients javadoc
Posted by "mimaison (via GitHub)" <gi...@apache.org>.
mimaison commented on code in PR #13239:
URL: https://github.com/apache/kafka/pull/13239#discussion_r1104341182
##########
clients/src/main/java/org/apache/kafka/common/security/oauthbearer/secured/package-info.java:
##########
@@ -16,6 +16,6 @@
*/
/**
* This package is deprecated.
- * @deprecated See {@link org.apache.kafka.common.security.oauthbearer}
+ * See {@link org.apache.kafka.common.security.oauthbearer}
Review Comment:
This was triggering the following warning: `Tag @deprecated cannot be used in package documentation.`
--
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
[GitHub] [kafka] mimaison commented on a diff in pull request #13239: MINOR: Various cleanups in clients javadoc
Posted by "mimaison (via GitHub)" <gi...@apache.org>.
mimaison commented on code in PR #13239:
URL: https://github.com/apache/kafka/pull/13239#discussion_r1105515715
##########
clients/src/main/java/org/apache/kafka/common/KafkaFuture.java:
##########
@@ -127,8 +127,6 @@ public static KafkaFuture<Void> allOf(KafkaFuture<?>... futures) {
public abstract <R> KafkaFuture<R> thenApply(BaseFunction<T, R> function);
/**
- * @see KafkaFuture#thenApply(BaseFunction)
Review Comment:
It links to the method above but we also link to the other method on the line just below.
--
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