ignite-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Prachi Garg (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (IGNITE-10852) [Documentation] - Add details on to public API behaviour
Date Thu, 10 Jan 2019 22:03:00 GMT

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

Prachi Garg commented on IGNITE-10852:
--------------------------------------

[~agerus], and [~ezhuravl] -

Please review - [https://apacheignite.readme.io/v2.7/docs/exception-handling-28] 

There are some '?' for Description and Action columns for some exceptions. I am not sure of
what needs to go in there. Please review the complete table and let me know what needs to
be fixed.

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

Mime
View raw message