Jefffrey opened a new issue, #24209:
URL: https://github.com/apache/datafusion/issues/24209
### Is your feature request related to a problem or challenge?
Try be more consistent with the generated docs for our UDFs
### Describe the solution you'd like
- [ ] lint/format the docs, such as ensuring the sql example is well
formatted
-
https://github.com/apache/datafusion/blob/bc48a4f7acd87a9779cb5a88d9b1a3f4ce506e45/docs/source/user-guide/sql/scalar_functions.md?plain=1#L5819-L5824
- see how last `|` is offset
- [ ] ensure argument names have consistent format (e.g. disallow `-`,
prefer `_`)
- [ ] some way to check that argument names match whats in the syntax example
- better yet, is there a way to auto generate the syntax examples from the
arguments? we'd need a way to get the function name, and a way to mark
arguments as optional
- [ ] anything else?
### Describe alternatives you've considered
_No response_
### Additional context
Related:
- https://github.com/apache/datafusion/pull/24134
--
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: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
