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

Automatically test doc examples in user guide #1813

Open
Tracked by #11172 ...
alamb opened this issue Feb 12, 2022 · 0 comments
Open
Tracked by #11172 ...

Automatically test doc examples in user guide #1813

alamb opened this issue Feb 12, 2022 · 0 comments
Labels
datafusion Changes in the datafusion crate development-process Related to development process of DataFusion enhancement New feature or request help wanted Extra attention is needed

Comments

@alamb
Copy link
Contributor

alamb commented Feb 12, 2022

Is your feature request related to a problem or challenge? Please describe what you are trying to do.

While preparing for the 7.0.0 release, I manually stumbled on to the fact that the example on https://arrow.apache.org/datafusion/user-guide/example-usage.html (and linked in the main crate's readme) didn't work! see #1812

Describe the solution you'd like
I would like the examples in the user guide to be run as part of the normal CI in datafusion so that we have confidence they will work even if we do change the API

Describe alternatives you've considered
N/A

Additional context
@returnString had this working once upon a time using the doc-comments crate -- apache/arrow#9749 not sure what happened

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
datafusion Changes in the datafusion crate development-process Related to development process of DataFusion enhancement New feature or request help wanted Extra attention is needed
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant