Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Minor: Improve object_store docs.rs landing page #4849

Merged
merged 2 commits into from
Sep 23, 2023

Conversation

alamb
Copy link
Contributor

@alamb alamb commented Sep 22, 2023

Which issue does this PR close?

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:
Screenshot 2023-09-22 at 4 05 10 PM

Are there any user-facing changes?

Docs

@alamb alamb marked this pull request as ready for review September 22, 2023 20:08
@github-actions github-actions bot added the object-store Object Store Interface label Sep 22, 2023
object_store/src/lib.rs Outdated Show resolved Hide resolved
object_store/src/lib.rs Outdated Show resolved Hide resolved
@tustvold
Copy link
Contributor

I took the liberty of fixing some minor typos

@tustvold tustvold merged commit 6d5d7e3 into apache:master Sep 23, 2023
@alamb alamb deleted the alamb/object_store_dpcs branch September 24, 2023 19:29
ryanaston pushed a commit to segmentio/arrow-rs that referenced this pull request Nov 6, 2023
* Improve object_store docs.rs landing page

* Apply suggestions from code review

---------

Co-authored-by: Raphael Taylor-Davies <1781103+tustvold@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
object-store Object Store Interface
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants