Hello Ferenc, Yes that would be the idea. I will re-write function's docs based on their latest implementations
Cheers, Ramin On Thu, Oct 29, 2026 at 4:07 PM Ferenc Csaky via dev <[email protected]> wrote: > +1, thanks for driving! > > One addition from my side: > > It would be good to double-check each function with the source code, cause > they > already diverged. I ran into issues multiple times when I only read the > docs, > but the actual behavior was different, or were not covered completely. > > Best, > Ferenc > > > > On Thursday, October 29th, 2026 at 08:36, Ramin Gharib < > [email protected]> wrote: > > > Hi dylanhz, > > > > Thanks for the feedback and the +1. No I don't think we need the Scala > tab. > > During the restructuring I will keep an eye out to remove it. > > > > @Xiqian I have added a new screenshot of the page with all the > > functions listed. > > > > Cheers, > > > > Ramin > > > > On Thu, Oct 29, 2026 at 8:20 AM dylanhz <[email protected]> wrote: > > > > > Hi Ramin, > > > > > > A strong +1 from me! More detailed, consistently structured docs would > be > > > easier for both human readers and AI agents to understand. > > > > > > One small question: since the Scala APIs are deprecated, do we still > need > > > the Scala syntax tab? > > > > > > Thanks! > > > > > > > > > ---------- > > > Best regards, > > > dylanhz > > > > > > > > > > > > > > > > 2026年10月28日 21:57，Ramin Gharib <[email protected]> 写道： > > > > > > > > Hi all, > > > > > > > > I'd like to restructure the built-in functions page [1]. It lists 306 > > > > functions and operators as table rows on a single page, each with a > > > > free-form description. Arguments, return values, NULL behavior and > errors > > > > are hard to find. > > > > > > > > The proposal picks up FLINK-23804 [2]: > > > > - Each function gets its own page with the same sections: syntax for > SQL > > > > and the Table API, arguments, returns, usage notes and examples. > > > > - The sidebar groups the function pages by category, and each > category > > > > folds open and closed. > > > > > > > > The screenshots [3] show REGEXP_EXTRACT and the sidebar in the new > > > layout, > > > > built locally with the current docs theme. > > > > > > > > I'd move one category per PR. Moving the existing entries is mostly > > > > mechanical, so I'd use AI assistance and fill in the AI disclosure > in the > > > > PR template. > > > > > > > > I would be interested in your feedback on this idea. > > > > > > > > Cheers, > > > > Ramin > > > > > > > > [1] > > > > > > > > https://nightlies.apache.org/flink/flink-docs-release-2.4/docs/sql/functions/built-in-functions/ > > > > [2] https://issues.apache.org/jira/browse/FLINK-23804 > > > > [3] > > > > https://drive.google.com/drive/folders/123rKBt0ESz5Wn5VSlCcQF3hxJuwtf3Q9 > > > > > > > > >
