You are viewing a plain text version of this content. The canonical link for it is here.
Posted to reviews@helix.apache.org by GitBox <gi...@apache.org> on 2020/10/16 20:52:13 UTC
[GitHub] [helix] narendly opened a new issue #1473: Improve JavaDoc in Helix APIs
narendly opened a new issue #1473:
URL: https://github.com/apache/helix/issues/1473
### Describe the bug
```
/**
* Get ideal state for a resource
* @param clusterName
* @param resourceName
* @return
*/
IdealState getResourceIdealState(String clusterName, String resourceName);
```
Our JavaDoc is lacking - it doesn't describe what will happen in failure cases where the cluster doesn't exist, or the resource doesn't exist. If the cluster doesn't exist, we should alert the user with an appropriate exception. If the resource doesn't exist, we should return null (existing behavior). These things should be documented clearly in the JavaDoc.
### To Reproduce
N/A
### Expected behavior
See above.
### Additional context
N/A
----------------------------------------------------------------
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:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@helix.apache.org
For additional commands, e-mail: reviews-help@helix.apache.org