Fix object_store docs and Add CI job #4684
Conversation
| @@ -65,6 +65,20 @@ jobs: | |||
| - name: Run clippy with all features and all targets | |||
| run: cargo clippy --all-features --all-targets -- -D warnings | |||
|
|
|||
| # test doc links still work | |||
| docs: | |||
There was a problem hiding this comment.
Perhaps we should also move the docs workflow into the arrow workflow, as it only applies to that workspace now?
There was a problem hiding this comment.
There is a docs workflow that checks the workspace: https://github.com/apache/arrow-rs/blob/master/.github/workflows/docs.yml
However, I think object_store is not part of the main workspace which is why it is not covered:
Lines 20 to 42 in c618438
There was a problem hiding this comment.
I added some comments to try and clarify the need
There was a problem hiding this comment.
Oh I agree on the need, I was perhaps suggesting we remove the docs.yml and merge it into arrow.yml
| @@ -17,7 +17,10 @@ | |||
|
|
|||
| use crate::config::Parse; | |||
|
|
|||
| /// Configure how to provide [`ObjectStore::copy_if_not_exists`] for [`AmazonS3`] | |||
There was a problem hiding this comment.
Rather than trying to actually make the link to [AmazonS3] work by conditionalizing the docs with the "grim" approach @tustvold describes in #4683 (comment) I opted to simply avoid the link, which I think is reasonable given this is in the aws module and has S3 in the name
object_store/src/aws/copy.rs
Outdated
| @@ -17,7 +17,10 @@ | |||
|
|
|||
| 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`. | |||
There was a problem hiding this comment.
| /// `AmazonS3`. | |
| /// [`AmazonS3`](super::AmazonS3). |
?
There was a problem hiding this comment.
Good call -- in 65f94a3
Which issue does this PR close?
Closes #4683
Rationale for this change
Docs are important and we don't want to find out they are broken after releasing a crate to crates.io
What changes are included in this PR?
Are there any user-facing changes?
No
Example CI failure: https://github.com/apache/arrow-rs/actions/runs/5832061836/job/15816723694?pr=4684
Example CI pass: https://github.com/apache/arrow-rs/actions/runs/5832147821/job/15816978755?pr=4684