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.

Sign up for GitHub

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2850533
Document all arrow features in docs.rs (#2633)
tustvold Sep 2, 2022
e54d1e2
Tweak pyarrow doc
tustvold Sep 2, 2022
7fe9d8b
Update arrow/Cargo.toml
tustvold Sep 2, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
3 changes: 3 additions & 0 deletions arrow/Cargo.toml
View file
Open in desktop
Expand Up @@ -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 😅

features = ["prettyprint", "ipc_compression", "dyn_cmp_dict", "ffi", "pyarrow"]

[features]
default = ["csv", "ipc", "json"]
ipc_compression = ["ipc", "zstd", "lz4"]
Expand Down
2 changes: 1 addition & 1 deletion arrow/src/pyarrow.rs
View file
Open in desktop
Expand Up @@ -15,7 +15,7 @@
// specific language governing permissions and limitations
// under the License.

//! This library demonstrates a minimal usage of Rust's C data interface to pass
//! This module demonstrates a minimal usage of Rust's C data interface to pass
//! arrays from and to Python.

use std::convert::{From, TryFrom};
Expand Down