Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Automate production of SQL and DataFrame references for SQL functions / Expressions #3092

Open
Tracked by #3058
andygrove opened this issue Aug 9, 2022 · 0 comments
Labels
development-process Related to development process of DataFusion documentation Improvements or additions to documentation enhancement New feature or request

Comments

@andygrove
Copy link
Member

Is your feature request related to a problem or challenge? Please describe what you are trying to do.
We are currently manually maintaining the user guide. In the same way that we generate the configuration section, we could generate much of the content in the SQL and DataFrame references.

Describe the solution you'd like
Define documentation in code and then generate markdown. The definition in the code can have SQL and DataFrame-specfic usage examples.

Describe alternatives you've considered
None

Additional context
None

@andygrove andygrove added the enhancement New feature or request label Aug 9, 2022
@andygrove andygrove added development-process Related to development process of DataFusion documentation Improvements or additions to documentation labels Aug 9, 2022
@alamb alamb mentioned this issue Apr 17, 2023
@alamb alamb added the devrel label Jul 24, 2023
@alamb alamb removed the devrel label Oct 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
development-process Related to development process of DataFusion documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants