[
https://issues.apache.org/jira/browse/FLINK-12395?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Bowen Li updated FLINK-12395:
-----------------------------
Description: We need to add more javadoc for {{getDescritpion()}} and
{{getDetailedDescription()}} APIs in CatalogBaseTable, including in which cases
they will be called, and how we expect developers to implement them (was:
CatalogBaseTable has {{getDescritpion()}} and {{getDetailedDescription()}} API,
which don't seem to make such sense. I'm not sure what's the use case of
detailed description, and how should users specify it in SQL and table api.
Probably should remove detailed description and rename "description" to
"comment".
Besides, for simplicity, we should consider just treating "comment" as a
property in properties map.
)
> Document description and detailed description in CatalogBaseTable
> -----------------------------------------------------------------
>
> Key: FLINK-12395
> URL: https://issues.apache.org/jira/browse/FLINK-12395
> Project: Flink
> Issue Type: Sub-task
> Reporter: Bowen Li
> Priority: Major
> Fix For: 1.9.0
>
>
> We need to add more javadoc for {{getDescritpion()}} and
> {{getDetailedDescription()}} APIs in CatalogBaseTable, including in which
> cases they will be called, and how we expect developers to implement them
--
This message was sent by Atlassian JIRA
(v7.6.3#76005)
