[
https://issues.apache.org/jira/browse/KAFKA-8482?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=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)
