[jira] [Commented] (KAFKA-8482) alterReplicaLogDirs should be better documented

[ASF GitHub Bot (Jira)]

[ 
https://issues.apache.org/jira/browse/KAFKA-8482?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=16955463#comment-16955463
 ] 

ASF GitHub Bot commented on KAFKA-8482:
---

omkreddy commented on pull request #7083: KAFKA-8482: alterReplicaLogDirs 
should be better documented
URL: https://github.com/apache/kafka/pull/7083
 
 
   
 

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.
 
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org


> alterReplicaLogDirs should be better documented
> ---
>
> Key: KAFKA-8482
> URL: https://issues.apache.org/jira/browse/KAFKA-8482
> Project: Kafka
>  Issue Type: Improvement
>  Components: admin
>Reporter: Colin McCabe
>Assignee: Dongjin Lee
>Priority: Major
>  Labels: newbie
> Fix For: 2.4.0
>
>
> alterReplicaLogDirs should be better documented.  In particular, it should 
> document what exceptions it throws in {{AdminClient.java}}



--
This message was sent by Atlassian Jira
(v8.3.4#803005)

[jira] [Commented] (KAFKA-8482) alterReplicaLogDirs should be better documented

[ASF GitHub Bot (JIRA)]

[ 
https://issues.apache.org/jira/browse/KAFKA-8482?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=16883701#comment-16883701
 ] 

ASF GitHub Bot commented on KAFKA-8482:
---

dongjinleekr commented on pull request #7083: KAFKA-8482: alterReplicaLogDirs 
should be better documented
URL: https://github.com/apache/kafka/pull/7083
 
 
   Here is the draft fix. In summary:
   
   1. `AdminClient#alterReplicaLogDirs`
   - Add documentation on when `InterruptedException` is thrown.
   - Add note on `AlterReplicaLogDirsResult` instance.
   2. `AlterReplicaLogDirsResult`
   - Add a guide to retrieve the results to class documentation.
   - Add detailed guide to `AlterReplicaLogDirsResult#values` what returns 
or what is thrown in which situation.
   - Add detailed guide to `AlterReplicaLogDirsResult#all` what returns or 
what is thrown in which situation.
   
   cc/ @cmccabe
   
   ### 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.
 
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org


> alterReplicaLogDirs should be better documented
> ---
>
> Key: KAFKA-8482
> URL: https://issues.apache.org/jira/browse/KAFKA-8482
> Project: Kafka
>  Issue Type: Improvement
>  Components: admin
>Reporter: Colin P. McCabe
>Priority: Major
>  Labels: newbie
> Fix For: 2.4.0
>
>
> alterReplicaLogDirs should be better documented.  In particular, it should 
> document what exceptions it throws in {{AdminClient.java}}



--
This message was sent by Atlassian JIRA
(v7.6.14#76016)

[jira] [Commented] (KAFKA-8482) alterReplicaLogDirs should be better documented

[Carlos Manuel Duclos Vergara (JIRA)]

[ 
https://issues.apache.org/jira/browse/KAFKA-8482?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=16858518#comment-16858518
 ] 

Carlos Manuel Duclos Vergara commented on KAFKA-8482:
-

Looking at the code, it seems that theoretically there could be several 
exceptions thrown, however I don't really see the relevance of documenting many 
of them, for example exceptions that come out of Map operations. Other than 
those exceptions, there is a mechanism to wrap exceptions so they appear as 
failures from a given replica.

Do you have any specific exceptions in mind? Or is this a catch all?

 

> alterReplicaLogDirs should be better documented
> ---
>
> Key: KAFKA-8482
> URL: https://issues.apache.org/jira/browse/KAFKA-8482
> Project: Kafka
>  Issue Type: Improvement
>  Components: admin
>Reporter: Colin P. McCabe
>Priority: Major
>  Labels: newbie
> Fix For: 2.4.0
>
>
> alterReplicaLogDirs should be better documented.  In particular, it should 
> document what exceptions it throws in {{AdminClient.java}}



--
This message was sent by Atlassian JIRA
(v7.6.3#76005)