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

Jark Wu commented on FLINK-23804:
---------------------------------

+1 
We should also add examples for each functions. 

> Restructure documentation of built-in functions
> -----------------------------------------------
>
>                 Key: FLINK-23804
>                 URL: https://issues.apache.org/jira/browse/FLINK-23804
>             Project: Flink
>          Issue Type: Improvement
>          Components: Documentation, Table SQL / API
>            Reporter: Ingo Bürk
>            Priority: Minor
>
> The current documentation for built-in functions does not scale well. Tables, 
> even in sections, become very hard to read with many entries, and there is 
> very little space for proper signatures, details, or examples.
> We should restructure this page such that functions are not grouped into 
> tables but rather their own sections. This could possibly involve splitting 
> the page into several pages (per category).
> In the end, we should have a documentation that lists signatures properly, 
> including return types, multiple signatures, signatures for both Table API 
> and SQL, allows for detailed descriptions of each function and various 
> examples in both APIs.



--
This message was sent by Atlassian Jira
(v8.3.4#803005)

Reply via email to