[arrow-rs] branch master updated: Minor: Improve object_store docs.rs landing page (#4849)

[tustvold]

This is an automated email from the ASF dual-hosted git repository.

tustvold pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/arrow-rs.git


The following commit(s) were added to refs/heads/master by this push:
     new 6d5d7e36ef Minor: Improve object_store docs.rs landing page (#4849)
6d5d7e36ef is described below

commit 6d5d7e36eff05be054221986f0e162a23cfe6a7e
Author: Andrew Lamb <and...@nerdnetworks.org>
AuthorDate: Sat Sep 23 13:18:56 2023 -0400

    Minor: Improve object_store docs.rs landing page (#4849)
    
    * Improve object_store docs.rs landing page
    
    * Apply suggestions from code review
    
    ---------
    
    Co-authored-by: Raphael Taylor-Davies 
<1781103+tustv...@users.noreply.github.com>
---
 object_store/src/http/mod.rs |  2 +-
 object_store/src/lib.rs      | 21 +++++++++++++--------
 2 files changed, 14 insertions(+), 9 deletions(-)

diff --git a/object_store/src/http/mod.rs b/object_store/src/http/mod.rs
index afbc0ce437..e9ed5902d8 100644
--- a/object_store/src/http/mod.rs
+++ b/object_store/src/http/mod.rs
@@ -17,7 +17,7 @@
 
 //! An object store implementation for generic HTTP servers
 //!
-//! This follows [rfc2518] commonly known called [WebDAV]
+//! This follows [rfc2518] commonly known as [WebDAV]
 //!
 //! Basic get support will work out of the box with most HTTP servers,
 //! even those that don't explicitly support [rfc2518]
diff --git a/object_store/src/lib.rs b/object_store/src/lib.rs
index 8d96ccf1df..cef10f1dd4 100644
--- a/object_store/src/lib.rs
+++ b/object_store/src/lib.rs
@@ -36,7 +36,7 @@
 //! clouds and local test environments, via a simple runtime
 //! configuration change.
 //!
-//! # Features:
+//! # Highlights
 //!
 //! 1. A focused, easy to use, idiomatic, well documented, high
 //! performance, `async` API.
@@ -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 are used to enable support for other implementations:
 //!
 #![cfg_attr(
     feature = "gcp",
-    doc = "* [Google Cloud Storage](https://cloud.google.com/storage/): 
[`GoogleCloudStorageBuilder`](gcp::GoogleCloudStorageBuilder)"
+    doc = "* `gcp`: [Google Cloud Storage](https://cloud.google.com/storage/) 
support. See [`GoogleCloudStorageBuilder`](gcp::GoogleCloudStorageBuilder)"
 )]
 #![cfg_attr(
     feature = "aws",
-    doc = "* [Amazon S3](https://aws.amazon.com/s3/): 
[`AmazonS3Builder`](aws::AmazonS3Builder)"
+    doc = "* `aws`: [Amazon S3](https://aws.amazon.com/s3/). See 
[`AmazonS3Builder`](aws::AmazonS3Builder)"
 )]
 #![cfg_attr(
     feature = "azure",
-    doc = "* [Azure Blob 
Storage](https://azure.microsoft.com/en-gb/services/storage/blobs/): 
[`MicrosoftAzureBuilder`](azure::MicrosoftAzureBuilder)"
+    doc = "* `azure`: [Azure Blob 
Storage](https://azure.microsoft.com/en-gb/services/storage/blobs/). See 
[`MicrosoftAzureBuilder`](azure::MicrosoftAzureBuilder)"
 )]
 #![cfg_attr(
     feature = "http",
-    doc = "* [HTTP Storage](https://datatracker.ietf.org/doc/html/rfc2518): 
[`HttpBuilder`](http::HttpBuilder)"
+    doc = "* `http`: [HTTP/WebDAV 
Storage](https://datatracker.ietf.org/doc/html/rfc2518). See 
[`HttpBuilder`](http::HttpBuilder)"
 )]
-//! * In Memory: [`InMemory`](memory::InMemory)
-//! * Local filesystem: [`LocalFileSystem`](local::LocalFileSystem)
 //!
 //! # Adapters
 //!