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

Restore DocBuilder::new() to avoid breaking API change #13870

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

alamb
Copy link
Contributor

@alamb alamb commented Dec 21, 2024

Which issue does this PR close?

Rationale for this change

I would like to help people upgrade DataFusion versions with as much help as possible. This means following the deprecation guidelines

Changes to DocBuilder introduced a breaking API change that could be confusing to some during upgrade

What changes are included in this PR?

  1. Restore DocumentationBuilder::new, and mark it `#[deprecated]``, following the deprecation guidelines
  2. Make DocumentationBuilder::new_with_defaults new to help users find the new API
  3. Add Default for DocSection to make it easier for users to bash out their own docs
  4. Improve some other docs

Are these changes tested?

Are there any user-facing changes?

@github-actions github-actions bot added the sql SQL Planner label Dec 21, 2024
@alamb alamb changed the title Restore DocBuilder::new() to avoid API change Restore DocBuilder::new() to avoid breaking API change Dec 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
sql SQL Planner
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Make DocBuilder migration in 44.0.0 easier
1 participant