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

Remove vestigal datafusion-docs module compilation #12081

Merged
merged 2 commits into from
Aug 21, 2024

Conversation

alamb
Copy link
Contributor

@alamb alamb commented Aug 20, 2024

Which issue does this PR close?

Part of #7013

Rationale for this change

The datafusion-docs module was added in #7952 by @andygrove before we had the ability to test the inline doc examples

However, we can now directly test inline documentation using doctest,

// Instructions for Documentation Examples
//
// The following commands test the examples from the user guide as part of
// `cargo test --doc`
//
// # Adding new tests:
//
// Simply add code like this to your .md file and ensure your md file is
// included in the lists below.
//
// ```rust
// <code here will be tested>
// ```
//
// Note that sometimes it helps to author the doctest as a standalone program
// first, and then copy it into the user guide.
//
// # Debugging Test Failures
//
// Unfortunately, the line numbers reported by doctest do not correspond to the
// line numbers of in the .md files. Thus, if a doctest fails, use the name of
// the test to find the relevant file in the list below, and then find the
// example in that file to fix.
//
// For example, if `user_guide_expressions(line 123)` fails,
// go to `docs/source/user-guide/expressions.md` to find the relevant problem.

The existence of these old examples now causes confusion (e.g. #12026 from @jc4x4)

Changes:

  1. Remove datafusion-docs

Note I will work with @jc4x4 tp add the relevant examples as part of #12026.

What changes are included in this PR?

Are these changes tested?

Are there any user-facing changes?

@edmondop
Copy link
Contributor

@alamb relates to #10768

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Aug 20, 2024
@alamb alamb marked this pull request as draft August 20, 2024 16:39
@alamb alamb marked this pull request as ready for review August 20, 2024 16:52
@alamb alamb merged commit eca71c4 into apache:main Aug 21, 2024
27 checks passed
@alamb
Copy link
Contributor Author

alamb commented Aug 21, 2024

🚀

@alamb alamb deleted the alamb/remove_old_docs branch August 21, 2024 15:24
This pull request was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants