Improve Ballista crate README content #878
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
houqp
approved these changes
Aug 14, 2021
| @@ -17,6 +17,102 @@ | |||
| under the License. | |||
| --> | |||
|
|
|||
| # Ballista - Rust | |||
| # Ballista: Distributed Scheduler for Apache Arrow DataFusion | |||
There was a problem hiding this comment.
have you considered using #![doc = include_str!("../README.md")] here to keep both versions in sync? we could annotate the example code with rust,no_run to make sure it's skipped in doc test and also renders properly on github.
There was a problem hiding this comment.
I had no idea about this feature ... thank you for pointing this out. I will update the PR tomorrow with this.
houqp
approved these changes
Aug 15, 2021
|
@andygrove looks like there is one minor rustfmt issue. |
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?
Closes #877.
Rationale for this change
Prior to the release I had added minimal rustdoc documentation to lib.rs in each crate but had forgotten / not realized that crates.io uses the README.md
What changes are included in this PR?
Essentially this is just a copy and paste of the rustdocs into the README for each crate
Are there any user-facing changes?
No