[ 
https://issues.apache.org/jira/browse/IGNITE-10852?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16739957#comment-16739957
 ] 

Evgenii Zhuravlev commented on IGNITE-10852:
--------------------------------------------

[~pgarg], I'd say that we need more information about each Exception type, so 
users could link somehow this exceptions with our API methods. I will prepare 
the list of APIs that are related to each Exception.

> [Documentation] - Add details on to public API behaviour
> --------------------------------------------------------
>
>                 Key: IGNITE-10852
>                 URL: https://issues.apache.org/jira/browse/IGNITE-10852
>             Project: Ignite
>          Issue Type: Improvement
>          Components: documentation
>    Affects Versions: 2.4, 2.5, 2.6, 2.7
>            Reporter: Alexander Gerus
>            Assignee: Prachi Garg
>            Priority: Major
>             Fix For: 2.8
>
>
> Current public API documentation has some specification gaps. In case if 
> method was not successfully executed, it is not clear what should be done by 
> user code.
> Good practice is to describe all API exceptions that can be processed by user 
> code and recommended actions



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

Reply via email to