You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@flink.apache.org by "Ingo Bürk (Jira)" <ji...@apache.org> on 2021/08/16 09:01:00 UTC

[jira] [Created] (FLINK-23804) Restructure documentation of built-in functions

Ingo Bürk created FLINK-23804:
---------------------------------

             Summary: 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


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)