[GitHub] [pinot] egalpin opened a new issue, #8829: Automate documented functions

[GitBox <gi...@apache.org>]

egalpin opened a new issue, #8829:
URL: https://github.com/apache/pinot/issues/8829

   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 


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@pinot.apache.org.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@pinot.apache.org
For additional commands, e-mail: commits-help@pinot.apache.org

[GitHub] [pinot] kkrugler commented on issue #8829: Automate documented functions

[GitBox <gi...@apache.org>]

kkrugler commented on issue #8829:
URL: https://github.com/apache/pinot/issues/8829#issuecomment-1146332109

   +10 for this.


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@pinot.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@pinot.apache.org
For additional commands, e-mail: commits-help@pinot.apache.org

[GitHub] [pinot] navina commented on issue #8829: Automate documented functions

[GitBox <gi...@apache.org>]

navina commented on issue #8829:
URL: https://github.com/apache/pinot/issues/8829#issuecomment-1154477256

   @mneedham is it possible to include javadocs from our code into the website documentation ? It seems like the easiest way to automate and ensure that the code and docs match and are up-to-date. 


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@pinot.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@pinot.apache.org
For additional commands, e-mail: commits-help@pinot.apache.org