You are viewing a plain text version of this content. The canonical link for it is here.
Posted to github@arrow.apache.org by "alamb (via GitHub)" <gi...@apache.org> on 2023/09/22 20:08:08 UTC
[GitHub] [arrow-rs] alamb opened a new pull request, #4849: Minor: Improve object_store docs.rs landing page
alamb opened a new pull request, #4849:
URL: https://github.com/apache/arrow-rs/pull/4849
# Which issue does this PR close?
<!--
We generally require a GitHub issue to be filed for all bug fixes and enhancements and this helps us generate change logs for our releases. You can link an issue to this PR using the GitHub syntax. For example `Closes #123` indicates that this PR will close issue #123.
-->
Closes #.
# Rationale for this change
I think it is somewhat unclear from docs.rs https://docs.rs/object_store/0.7.0/object_store/, without some poking around in the code, what feature flags exist for the `object_store` crate and what is available by default.
# What changes are included in this PR?
Improve the documentation to explicitly mention the feature flag
New rendering:
# Are there any user-facing changes?
Docs
<!--
If there are user-facing changes then we may require documentation to be updated before approving the PR.
-->
<!---
If there are any breaking changes to public APIs, please add the `breaking change` label.
-->
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow-rs] tustvold merged pull request #4849: Minor: Improve object_store docs.rs landing page
Posted by "tustvold (via GitHub)" <gi...@apache.org>.
tustvold merged PR #4849:
URL: https://github.com/apache/arrow-rs/pull/4849
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow-rs] tustvold commented on a diff in pull request #4849: Minor: Improve object_store docs.rs landing page
Posted by "tustvold (via GitHub)" <gi...@apache.org>.
tustvold commented on code in PR #4849:
URL: https://github.com/apache/arrow-rs/pull/4849#discussion_r1335026457
##########
object_store/src/lib.rs:
##########
@@ -36,7 +36,7 @@
//! clouds and local test environments, via a simple runtime
//! configuration change.
//!
-//! # Features:
+//! # Higlights
Review Comment:
```suggestion
//! # Highlights
```
##########
object_store/src/lib.rs:
##########
@@ -53,26 +53,31 @@
//! [InfluxDB IOx]: https://github.com/influxdata/influxdb_iox/
//! [crates.io]: https://github.com/rust-lang/crates.io
//!
-//! # Example: Create an [`ObjectStore`] implementation:
+//! # Available [`ObjectStore`] Implementations
+//!
+//! By default, this crate provides the following implementations:
+//!
+//! * Memory: [`InMemory`](memory::InMemory)
+//! * Local filesystem: [`LocalFileSystem`](local::LocalFileSystem)
+//!
+//! Feature flags on used to enable support for other implementations:
Review Comment:
```suggestion
//! Feature flags are used to enable support for other implementations:
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow-rs] tustvold commented on pull request #4849: Minor: Improve object_store docs.rs landing page
Posted by "tustvold (via GitHub)" <gi...@apache.org>.
tustvold commented on PR #4849:
URL: https://github.com/apache/arrow-rs/pull/4849#issuecomment-1732361755
I took the liberty of fixing some minor typos
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org