You are viewing a plain text version of this content. The canonical link for it is here.

Posted to dev@ignite.apache.org by "Alexander Gerus (JIRA)" <ji...@apache.org> on 2018/12/29 19:30:00 UTC

[jira] [Created] (IGNITE-10852) [Documentation] - Add details on to public API behaviour

Alexander Gerus created IGNITE-10852:
----------------------------------------

             Summary: [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.7, 2.6, 2.5, 2.4
            Reporter: Alexander Gerus


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)