fix(docs): Update broken links to TableProvider docs
#16830
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
github-actions
bot
added
documentation
2010YOUY01
approved these changes
Jul 21, 2025
There was a problem hiding this comment.
Thanks for the fix
Noter: Other broken links may still exist. I tried using cargo deadlinks to detect them automatically but the output was too verbose. I'll explore this later.
I tried, and that's true. There are many errors I don't understand.
Perhaps we can first filter, and only check there are no 404 pages in the src comments 🤔
This was referenced Jul 21, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Which issue does this PR close?
Rationale for this change
Fixes broken links to the
TableProvidertrait in the Rust and website docs. I found them while manually browsing the docs.The following links are broken:
https://docs.rs/datafusion/latest/datafusion/datasource/provider/trait.TableProvider.htmlhttps://docs.rs/datafusion/latest/datafusion/datasource/provider/trait.TableProvider.html#tymethod.scanTableProviderlink on the Building Logical Plans library user guide.What changes are included in this PR?
To find all instances, I grepped the codebase for the common path
datafusion/datasource/providerand fixed the links I found.Noter: Other broken links may still exist. I tried using cargo deadlinks to detect them automatically but the output was too verbose. I'll explore this later.
Are these changes tested?
Verified that the updated
TableProviderlinks work correctly by building the docs in local locally and manually checking the following generated pages:/target/doc/datafusion/catalog/default_table_source/struct.DefaultTableSource.html/target/doc/datafusion/logical_expr/trait.TableSource.html/docs/build/html/library-user-guide/building-logical-plans.htmlAre there any user-facing changes?
No.