[GitHub] [kafka] jlprat commented on a change in pull request #11298: MINOR: "partition" typos and method doc arg fix

[GitBox <gi...@apache.org>]

jlprat commented on a change in pull request #11298:
URL: https://github.com/apache/kafka/pull/11298#discussion_r702762251



##########
File path: core/src/main/scala/kafka/log/LogCleanerManager.scala
##########
@@ -359,9 +359,10 @@ private[log] class LogCleanerManager(val logDirs: Seq[File],
    *
    * @param dataDir                       The File object to be updated
    * @param partitionToUpdateOrAdd        The [TopicPartition, Long] map data to be updated. pass "none" if doing remove, not add
-   * @param topicPartitionToBeRemoved     The TopicPartition to be removed
+   * @param partitionToRemove             The TopicPartition to be removed

Review comment:
       Now that you are modifying this, probably it's worth mentioning that this `Option` parameter has a default value and what it means when `None` is passed.




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