Improve contributor guide and main API landing page#5921
Merged
alamb merged 1 commit intoapache:mainfrom Apr 10, 2023
Merged
Conversation
Move some content into the code organization section
github-actions
bot
added
core
alamb
commented
Apr 8, 2023
|
|
||
| To run the examples, use the `cargo run` command, such as: | ||
|
|
||
| ```bash |
Contributor
Author
There was a problem hiding this comment.
Moved from the main lib.rs guide
alamb
commented
Apr 8, 2023
| /// | ||
| /// If some trait object, such as `dyn T`, implements this trait, | ||
| /// its related Arc<dyn T> will automatically implement [`TreeNode`] | ||
| /// its related `Arc<dyn T>` will automatically implement [`TreeNode`] |
Contributor
Author
There was a problem hiding this comment.
drive by rustdoc cleanups
| //! | ||
| //! [datafusion-examples]: https://github.com/apache/arrow-datafusion/tree/main/datafusion-examples | ||
| //! | ||
| //! ## Customization and Extension |
Contributor
Author
There was a problem hiding this comment.
I rearranged and expanded the customization points
| //! | ||
| //! ## Examples | ||
| //! | ||
| //! Examples are located in [datafusion-examples directory](https://github.com/apache/arrow-datafusion/tree/main/datafusion-examples) |
Contributor
Author
There was a problem hiding this comment.
I moved the link to the other examples up with the other examples, and then moved the details on running closer to the examples themselves in the datafusion-examples directory
| [Crate Documentation], to keep it as close to the source as | ||
| possible. | ||
|
|
||
| - [Apr 2023]: The Apache Arrow DataFusion Architecture talks series by @alamb |
Contributor
Author
There was a problem hiding this comment.
Moved to the main library docs
alamb
changed the title
7 tasks
jackwener
approved these changes
Apr 9, 2023
korowa
pushed a commit
to korowa/arrow-datafusion
that referenced
this pull request
Apr 13, 2023
Move some content into the code organization section
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Move some content into the code organization section
Which issue does this PR close?
Part of #5501
Rationale for this change
I would like to make it easier for people to find, use, and contribute to DataFusion
What changes are included in this PR?
Are these changes tested?
I reviewed the built docs locally
Are there any user-facing changes?
(Hopefully) Better docs