You are viewing a plain text version of this content. The canonical link for it is here.
Posted to jira@kafka.apache.org by "lucasbru (via GitHub)" <gi...@apache.org> on 2023/01/25 18:00:30 UTC
[GitHub] [kafka] lucasbru opened a new pull request, #13164: chore: Fix scaladoc warnings
lucasbru opened a new pull request, #13164:
URL: https://github.com/apache/kafka/pull/13164
Make sure no scaladoc warnings are emitted from the streams-scala project build. We cannot fully fix all scaladoc warnings due to limitations of the scaladoc tool, so this is a best-effort attempt at fixing as many warnings as possible. We also disable one problematic class of scaladoc wornings (link errors) in the gradle build.
The causes of existing warnings are that we link to java members from scaladoc, which is not possible, or we fail to disambiguate some members.
The broad rule applied in the changes is
- For links to Java members such as [[StateStore]], we use the fully qualified name in a code tag to make manual link resolution via a search engine easy.
- For some common terms that are also linked to Java members, like [[Serde]], we omit the link.
- We disambiguate where possible.
- In the special case of @throws declarations with Java Exceptions, we do not seem to be able to avoid the warning altogther.
### Committer Checklist (excluded from commit message)
- [x] Verify design and implementation
- [x] Verify test coverage and CI build status
- [x] 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] mjsax commented on a diff in pull request #13164: MINOR: Fix scaladoc warnings
Posted by "mjsax (via GitHub)" <gi...@apache.org>.
mjsax commented on code in PR #13164:
URL: https://github.com/apache/kafka/pull/13164#discussion_r1087040518
##########
streams/streams-scala/src/main/scala/org/apache/kafka/streams/scala/kstream/Consumed.scala:
##########
@@ -43,7 +43,7 @@ object Consumed {
ConsumedJ.`with`(keySerde, valueSerde, timestampExtractor, resetPolicy)
/**
- * Create an instance of [[Consumed]] with key and value [[Serde]]s.
+ * Create an instance of [[Consumed]] with key and value Serdes.
Review Comment:
Should this be `[[Serdes]]` -- Would need to resolve the "conflict" between `org.apache.kafka.streams.scala.Serdes` (deprecated; we should not use) and `org.apache.kafka.streams.scala.serialization.Serdes` though.
Similar elsewhere.
--
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] guozhangwang merged pull request #13164: MINOR: Fix scaladoc warnings
Posted by "guozhangwang (via GitHub)" <gi...@apache.org>.
guozhangwang merged PR #13164:
URL: https://github.com/apache/kafka/pull/13164
--
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] lucasbru commented on a diff in pull request #13164: MINOR: Fix scaladoc warnings
Posted by "lucasbru (via GitHub)" <gi...@apache.org>.
lucasbru commented on code in PR #13164:
URL: https://github.com/apache/kafka/pull/13164#discussion_r1087656183
##########
streams/streams-scala/src/main/scala/org/apache/kafka/streams/scala/kstream/Consumed.scala:
##########
@@ -43,7 +43,7 @@ object Consumed {
ConsumedJ.`with`(keySerde, valueSerde, timestampExtractor, resetPolicy)
/**
- * Create an instance of [[Consumed]] with key and value [[Serde]]s.
+ * Create an instance of [[Consumed]] with key and value Serdes.
Review Comment:
What is meant here is that we are talking about two `Serde` instances, key and value, and not the `Serdes` factory class, or not?
--
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] lucasbru commented on pull request #13164: MINOR: Fix scaladoc warnings
Posted by "lucasbru (via GitHub)" <gi...@apache.org>.
lucasbru commented on PR #13164:
URL: https://github.com/apache/kafka/pull/13164#issuecomment-1410168606
@mjsax can we merge this?
--
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] guozhangwang commented on pull request #13164: MINOR: Fix scaladoc warnings
Posted by "guozhangwang (via GitHub)" <gi...@apache.org>.
guozhangwang commented on PR #13164:
URL: https://github.com/apache/kafka/pull/13164#issuecomment-1410744946
LGTM, Merged to trunk.
--
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