Document crate feature flags #7713
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
github-actions
bot
added
documentation
alamb
commented
Oct 1, 2023
| @@ -39,8 +39,8 @@ avro = ["apache-avro", "num-traits", "datafusion-common/avro"] | |||
| backtrace = ["datafusion-common/backtrace"] | |||
| compression = ["xz2", "bzip2", "flate2", "zstd", "async-compression"] | |||
| crypto_expressions = ["datafusion-physical-expr/crypto_expressions", "datafusion-optimizer/crypto_expressions"] | |||
| default = ["crypto_expressions", "encoding__expressions", "regex_expressions", "unicode_expressions", "compression"] | |||
There was a problem hiding this comment.
Drive by fix: I believe the double _ _ is a typo that results in this feature always being on. This makes it so users can disable it if needed
| @@ -187,10 +187,6 @@ DataFusion is designed to be extensible at all points. To that end, you can prov | |||
| - [x] User Defined `LogicalPlan` nodes | |||
| - [x] User Defined `ExecutionPlan` nodes | |||
|
|
|||
| ## Rust Version Compatibility | |||
There was a problem hiding this comment.
moved to the main landing page
yjshen
approved these changes
Oct 3, 2023
Ted-Jiang
pushed a commit
to Ted-Jiang/arrow-datafusion
that referenced
this pull request
Oct 7, 2023
* Document crate feature flags * prettier
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 #7711
Rationale for this change
I would like to make it as easy as possible to use datafusion, which includes good documentation. See #7711 for details
What changes are included in this PR?
See rendered version here: https://github.com/alamb/arrow-datafusion/tree/alamb/doc_intro#readme
Improve the github / crates.io landing page:
Are these changes tested?
N/A
Are there any user-facing changes?