kevinjqliu opened a new pull request, #750:
URL: https://github.com/apache/arrow-rs-object-store/pull/750
# 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 #749.
# Rationale for this change
<!--
Why are you proposing this change? If this is already explained clearly in
the issue then this section is not needed.
Explaining clearly why changes are proposed helps reviewers understand your
changes and offer better suggestions for fixes.
-->
# What changes are included in this PR?
Follow up to #724
PR #724 made `reqwest` optional and introduced `*-base` provider features,
but the crate docs only mentioned them in passing. This PR adds three doc
sections to the crate-level module docs, grouped at the bottom as a
"configuration" cluster:
- **`# Feature Flags`** — Layering rationale + three reference tables
(provider, transport/shared, other), covering `cloud-base`, `cloud`,
`tls-webpki-roots`, `integration`, etc.
- **`# Customizing HTTP Clients`** — Existing section, now cross-references
*Disabling reqwest*.
- **`# Disabling reqwest`** — When to use `*-base`, a `Cargo.toml` snippet,
and an `AmazonS3Builder::with_http_connector` example.
Per-provider module docs (`aws`, `azure`, `gcp`, `http`) now link to the
*Feature Flags* table so readers can see the `aws` vs `aws-base` comparison
directly. README gains a `## Disabling reqwest` section mirroring the lib.rs
explainer alongside the existing `wasm32-wasip1` build command.
<!--
There is no need to duplicate the description in the issue here but it is
sometimes worth providing a summary of the individual changes in this PR.
-->
# Are there any user-facing changes?
<!--
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 call them out.
-->
--
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: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
