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

Posted to issues@calcite.apache.org by "Josh Elser (JIRA)" <ji...@apache.org> on 2015/12/18 22:40:46 UTC

[jira] [Created] (CALCITE-1029) Add "purpose" explanations to Avatica JSON docs

Josh Elser created CALCITE-1029:
-----------------------------------

             Summary: Add "purpose" explanations to Avatica JSON docs
                 Key: CALCITE-1029
                 URL: https://issues.apache.org/jira/browse/CALCITE-1029
             Project: Calcite
          Issue Type: Improvement
          Components: site
            Reporter: Josh Elser
            Assignee: Josh Elser
             Fix For: next


Looking at the JSON docs again, they serve as a easily viewable/readable source for what objects (requests, responses, and "other") might be used with the JSON API. An area in which it is lacking is how each of these objects is actually used.

Add a brief explanation to each object that describe how (and why, if necessary to give adequate explanation to "how") each are used, similar to a class-level Javadoc comment feel.



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)