apache / apache/pinot

Automate documented functions

Open
#8,829 2 comments 1 reaction 0 assignees View on GitHub
Dominant language
Java
Stars
6.1k
Forks
1.5k
Avg merge
2d 3h
Merged PRs (30d)
195

Description

In the Pinot docs[1], only a subset of available functions are documented. I think it would be highly valuable to automate listing any function found in code[2] to be part of those docs. Even if the default behaviour was to link to the definition in code, it would still provide better discovery for anyone writing queries and only looking at the docs.

[1] https://docs.pinot.apache.org/configuration-reference/functions
[2] https://github.com/apache/pinot/tree/master/pinot-core/src/main/java/org/apache/pinot/core/operator/transform/function

Contributor guide

Open the contributing guide

Research direction

Start with the Pinot functions documentation at docs.pinot.apache.org/configuration-reference/functions and the Java function definitions under pinot-core/src/main/java/org/apache/pinot/core/operator/transform/function. Determine how functions are currently discovered and documented, then define a generated listing that covers every function found in code. Done means the documentation exposes all discovered functions, including links to definitions where full descriptions are unavailable.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
documentation
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.