You are viewing a plain text version of this content. The canonical link for it is here.
Posted to jira@kafka.apache.org by GitBox <gi...@apache.org> on 2022/02/09 12:51:44 UTC

[GitHub] [kafka] lmr3796 opened a new pull request #11744: MINOR: Fix JavaDoc of OffsetIndex#append

lmr3796 opened a new pull request #11744:
URL: https://github.com/apache/kafka/pull/11744


   The Java doc for the thrown exception is added in (apache#4975)
   https://github.com/apache/kafka/pull/4975/files#diff-f3714fa2bb7e07c857d2cafde9dcb5d310fafd2cceed9f4124cc6342671a2c89R137
   
   By the time it was already a typo.


-- 
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 #11744: MINOR: Fix JavaDoc of OffsetIndex#append

Posted by GitBox <gi...@apache.org>.
mimaison merged pull request #11744:
URL: https://github.com/apache/kafka/pull/11744


   


-- 
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] lmr3796 commented on pull request #11744: MINOR: Fix JavaDoc of OffsetIndex#append

Posted by GitBox <gi...@apache.org>.
lmr3796 commented on pull request #11744:
URL: https://github.com/apache/kafka/pull/11744#issuecomment-1033729356


   Hi @chia7712 can I get a review from you for this minor patch?


-- 
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] lmr3796 closed pull request #11744: MINOR: Fix JavaDoc of OffsetIndex#append

Posted by GitBox <gi...@apache.org>.
lmr3796 closed pull request #11744:
URL: https://github.com/apache/kafka/pull/11744


   


-- 
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 change in pull request #11744: MINOR: Fix JavaDoc of OffsetIndex#append

Posted by GitBox <gi...@apache.org>.
mimaison commented on a change in pull request #11744:
URL: https://github.com/apache/kafka/pull/11744#discussion_r803007182



##########
File path: core/src/main/scala/kafka/log/OffsetIndex.scala
##########
@@ -136,7 +136,7 @@ class OffsetIndex(_file: File, baseOffset: Long, maxIndexSize: Int = -1, writabl
 
   /**
    * Append an entry for the given offset/location pair to the index. This entry must have a larger offset than all subsequent entries.
-   * @throws IndexOffsetOverflowException if the offset causes index offset to overflow
+   * @throws InvalidOffsetException if the offset causes index offset to overflow

Review comment:
       This method does indeed throw `IndexOffsetOverflowException` (from `relativeOffset()`) for the reason listed. 
   
   I'm assuming you got confused because it also throws `InvalidOffsetException`. It's ok to add another `@throws` tag if you want but we don't want to remove the existing one.




-- 
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] lmr3796 commented on a change in pull request #11744: MINOR: Fix JavaDoc of OffsetIndex#append

Posted by GitBox <gi...@apache.org>.
lmr3796 commented on a change in pull request #11744:
URL: https://github.com/apache/kafka/pull/11744#discussion_r803018010



##########
File path: core/src/main/scala/kafka/log/OffsetIndex.scala
##########
@@ -136,7 +136,7 @@ class OffsetIndex(_file: File, baseOffset: Long, maxIndexSize: Int = -1, writabl
 
   /**
    * Append an entry for the given offset/location pair to the index. This entry must have a larger offset than all subsequent entries.
-   * @throws IndexOffsetOverflowException if the offset causes index offset to overflow
+   * @throws InvalidOffsetException if the offset causes index offset to overflow

Review comment:
       Ah @mimaison you're right.  Let me try to change it




-- 
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] lmr3796 commented on a change in pull request #11744: MINOR: Fix JavaDoc of OffsetIndex#append

Posted by GitBox <gi...@apache.org>.
lmr3796 commented on a change in pull request #11744:
URL: https://github.com/apache/kafka/pull/11744#discussion_r803031914



##########
File path: core/src/main/scala/kafka/log/OffsetIndex.scala
##########
@@ -136,7 +136,7 @@ class OffsetIndex(_file: File, baseOffset: Long, maxIndexSize: Int = -1, writabl
 
   /**
    * Append an entry for the given offset/location pair to the index. This entry must have a larger offset than all subsequent entries.
-   * @throws IndexOffsetOverflowException if the offset causes index offset to overflow
+   * @throws InvalidOffsetException if the offset causes index offset to overflow

Review comment:
       Thanks for taking time to review @mimaison!
   
   I've added the exception kept the original one.




-- 
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