[arrow-rs] branch master updated: Fix object_store docs and Add CI job (#4684)

[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 df28eafb08 Fix object_store docs and Add CI job  (#4684)
df28eafb08 is described below

commit df28eafb08da436286d08f6170c1a24db3b11274
Author: Andrew Lamb <and...@nerdnetworks.org>
AuthorDate: Fri Aug 11 10:53:11 2023 -0400

    Fix object_store docs and Add CI job  (#4684)
    
    * Add CI job for object_store_docs
    
    * fix job
    
    * fix again
    
    * fix
    
    * Fix doc links
    
    * Add comment about why a different workflow is needed
    
    * Fix AmazonS3 link
---
 .github/workflows/object_store.yml | 20 +++++++++++++++++++-
 object_store/src/aws/copy.rs       |  8 +++++++-
 2 files changed, 26 insertions(+), 2 deletions(-)

diff --git a/.github/workflows/object_store.yml 
b/.github/workflows/object_store.yml
index 7858da1e2d..01e14022e1 100644
--- a/.github/workflows/object_store.yml
+++ b/.github/workflows/object_store.yml
@@ -65,6 +65,24 @@ jobs:
       - name: Run clippy with all features and all targets
         run: cargo clippy --all-features --all-targets -- -D warnings
 
+  # test doc links still work
+  #
+  # Note that since object_store is not part of the main workspace,
+  # this needs a separate docs job as it is not covered by
+  # `cargo doc --workspace`
+  docs:
+    name: Rustdocs
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        working-directory: object_store
+    env:
+      RUSTDOCFLAGS: "-Dwarnings"
+    steps:
+      - uses: actions/checkout@v3
+      - name: Run cargo doc
+        run: cargo doc --document-private-items --no-deps --workspace 
--all-features
+
   # test the crate
   # This runs outside a container to workaround lack of support for passing 
arguments
   # to service containers - https://github.com/orgs/community/discussions/26688
@@ -152,4 +170,4 @@ jobs:
       - name: Build wasm32-unknown-unknown
         run: cargo build --target wasm32-unknown-unknown
       - name: Build wasm32-wasi
-        run: cargo build --target wasm32-wasi
\ No newline at end of file
+        run: cargo build --target wasm32-wasi
diff --git a/object_store/src/aws/copy.rs b/object_store/src/aws/copy.rs
index 6b96f992ce..da4e2809be 100644
--- a/object_store/src/aws/copy.rs
+++ b/object_store/src/aws/copy.rs
@@ -17,7 +17,11 @@
 
 use crate::config::Parse;
 
-/// Configure how to provide [`ObjectStore::copy_if_not_exists`] for 
[`AmazonS3`]
+/// Configure how to provide [`ObjectStore::copy_if_not_exists`] for
+/// [`AmazonS3`].
+///
+/// [`ObjectStore::copy_if_not_exists`]: crate::ObjectStore::copy_if_not_exists
+/// [`AmazonS3`]: super::AmazonS3
 #[derive(Debug, Clone)]
 #[non_exhaustive]
 pub enum S3CopyIfNotExists {
@@ -32,6 +36,8 @@ pub enum S3CopyIfNotExists {
     ///
     /// For example `header: cf-copy-destination-if-none-match: *`, would set
     /// the header `cf-copy-destination-if-none-match` to `*`
+    ///
+    /// [`ObjectStore::copy_if_not_exists`]: 
crate::ObjectStore::copy_if_not_exists
     Header(String, String),
 }