[
https://issues.apache.org/jira/browse/CALCITE-2048?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16250365#comment-16250365
]
Julian Hyde commented on CALCITE-2048:
--------------------------------------
I agree there are are lot of concepts to cover. However if we document the
concepts one after the other it would read like a service manual and be so
difficult to read that it will not enlighten anyone.
I think a better approach is to describe particular use cases as worked
examples. Start with a simple use case. Then introduce an example that uses a
custom cost model. And so forth. The examples would explain not only how to
create a custom cost model but also why you would want to.
Documentation for the concepts is probably best left to the javadoc for those
classes (which already exists) and to a presentation (which would introduce the
concepts, and have a slide for each concept, but not contain full working
examples).
> Create a better documentation for the Planner design
> ----------------------------------------------------
>
> Key: CALCITE-2048
> URL: https://issues.apache.org/jira/browse/CALCITE-2048
> Project: Calcite
> Issue Type: Improvement
> Components: core
> Reporter: Edmon Begoli
> Assignee: Edmon Begoli
> Priority: Minor
> Original Estimate: 672h
> Remaining Estimate: 672h
>
> Per request of the development community, and the assessment that we need a
> tutorial, documentation and example code to work directly with the planner,
> because it is a lot harder to work with the planner than with an adapter.
--
This message was sent by Atlassian JIRA
(v6.4.14#64029)
