Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Document all arrow features in docs.rs (#2633) #2634

Merged
merged 3 commits into from Sep 2, 2022
Merged

Document all arrow features in docs.rs (#2633) #2634

merged 3 commits into from Sep 2, 2022

Conversation

tustvold
Copy link
Contributor

@tustvold tustvold commented Sep 2, 2022

Which issue does this PR close?

Closes #2633

Rationale for this change

What changes are included in this PR?

Are there any user-facing changes?

@github-actions github-actions bot added the arrow Changes to the arrow crate label Sep 2, 2022
viirya
viirya reviewed Sep 2, 2022
View reviewed changes
arrow/Cargo.toml Outdated Show resolved Hide resolved
@tustvold @viirya
Update arrow/Cargo.toml
7fe9d8b 
Co-authored-by: Liang-Chi Hsieh <viirya@gmail.com>
alamb
alamb approved these changes Sep 2, 2022
View reviewed changes
Copy link
Contributor

@alamb alamb left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice --

See #1695 for details of how I tested this previously

Also, this has more info: #1349

arrow/Cargo.toml
@@ -67,6 +67,9 @@ multiversion = { version = "0.6.1", default-features = false }
bitflags = { version = "1.2.1", default-features = false }
zstd = { version = "0.11.1", default-features = false, optional = true }

[package.metadata.docs.rs]
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We did something similar with parquet but used --all-features:
https://github.com/apache/arrow-rs/blob/master/parquet/Cargo.toml#L67-L68

I suspect the reason we can't do so in this case is that the simd feature will cause the docs build to fail as it doesn't use nightly?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I didn't want to risk it 😅

@tustvold tustvold merged commit a9875f5 into apache:master Sep 2, 2022
@ursabot
Copy link

ursabot commented Sep 2, 2022

Benchmark runs are scheduled for baseline = 41a2d2d and contender = a9875f5. a9875f5 is a master commit associated with this PR. Results will be available as each benchmark for each run completes.
Conbench compare runs links:
[Skipped ⚠️ Benchmarking of arrow-rs-commits is not supported on ec2-t3-xlarge-us-east-2] ec2-t3-xlarge-us-east-2
[Skipped ⚠️ Benchmarking of arrow-rs-commits is not supported on test-mac-arm] test-mac-arm
[Skipped ⚠️ Benchmarking of arrow-rs-commits is not supported on ursa-i9-9960x] ursa-i9-9960x
[Skipped ⚠️ Benchmarking of arrow-rs-commits is not supported on ursa-thinkcentre-m75q] ursa-thinkcentre-m75q
Buildkite builds:
Supported benchmarks:
ec2-t3-xlarge-us-east-2: Supported benchmark langs: Python, R. Runs only benchmarks with cloud = True
test-mac-arm: Supported benchmark langs: C++, Python, R
ursa-i9-9960x: Supported benchmark langs: Python, R, JavaScript
ursa-thinkcentre-m75q: Supported benchmark langs: C++, Java

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@viirya viirya viirya left review comments

@alamb alamb alamb approved these changes

Assignees
No one assigned
Labels
arrow Changes to the arrow crate
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Document All Arrow Features in docs.rs
4 participants
@tustvold @ursabot @viirya @alamb