Fix doc build on catalog API #5
Merged
Conversation
This file contains 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
alamb
commented
Jul 25, 2024
| @@ -52,7 +52,7 @@ use std::sync::Arc; | |||
| /// ``` | |||
| /// # use datafusion_catalog::Session; | |||
| /// # use datafusion_common::{Result, exec_datafusion_err}; | |||
| /// struct SessionState {} | |||
| /// # struct SessionState {} | |||
There was a problem hiding this comment.
Putting a # in front of this means the statement is not shown in the resulting documentation
alamb
commented
Jul 25, 2024
| @@ -63,7 +63,7 @@ use std::sync::Arc; | |||
| /// ``` | |||
| /// | |||
| /// [`SessionState`]: https://docs.rs/datafusion/latest/datafusion/execution/session_state/struct.SessionState.html | |||
| /// [TableProvider]: crate::TableProvider | |||
| /// [`TableProvider`]: crate::TableProvider | |||
There was a problem hiding this comment.
This is the fix for the doc failure 🤦
|
cc @findepi |
|
thank you! |
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.
This targets the catalog API PR in DataFusion, apache#11516
I broke the doc tests in #4 due a broken link
This PR fixes that (and improves the example slightly)