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

Improve object_store crate documentation #2260

Merged
merged 4 commits into from
Aug 2, 2022

Conversation

alamb
Copy link
Contributor

@alamb alamb commented Aug 1, 2022

Which issue does this PR close?

Closes #2202

Rationale for this change

More docs == more better

What changes are included in this PR?

Example front page:

Screen Shot 2022-08-01 at 8 36 08 AM

Are there any user-facing changes?

Better docs

@alamb alamb added the documentation Improvements or additions to documentation label Aug 1, 2022
@alamb alamb changed the title Improve object_store crate documentation Improve object_store crate documentation Aug 1, 2022
@github-actions github-actions bot added the object-store Object Store Interface label Aug 1, 2022
Copy link
Contributor

@tustvold tustvold left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Minor nits, thank you for doing this

object_store/README.md Outdated Show resolved Hide resolved
Comment on lines +22 to +23
A focused, easy to use, idiomatic, high performance, `async` object
store library interacting with object stores.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
A focused, easy to use, idiomatic, high performance, `async` object
store library interacting with object stores.
A high performance, `async` object store crate that provides a
uniform interface for interacting with various kinds of object store

I think all the qualifiers is a bit much 😆

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am practicing "marketing" -- I would like to run an experiment to see how much attention I can garner with a buzzword laden lead compared to a more utilitarian, less self-aggrandizing, summary.

object_store/src/lib.rs Outdated Show resolved Hide resolved
object_store/src/lib.rs Show resolved Hide resolved
Co-authored-by: Raphael Taylor-Davies <[email protected]>
@codecov-commenter
Copy link

Codecov Report

Merging #2260 (990f81b) into master (2c09ba4) will increase coverage by 0.00%.
The diff coverage is 100.00%.

❗ Current head 990f81b differs from pull request most recent head 88e2060. Consider uploading reports for the commit 88e2060 to get more accurate results

@@           Coverage Diff           @@
##           master    #2260   +/-   ##
=======================================
  Coverage   82.28%   82.28%           
=======================================
  Files         245      245           
  Lines       62670    62688   +18     
=======================================
+ Hits        51567    51585   +18     
  Misses      11103    11103           
Impacted Files Coverage Δ
object_store/src/aws.rs 0.00% <ø> (ø)
object_store/src/azure.rs 0.00% <ø> (ø)
object_store/src/gcp.rs 0.00% <ø> (ø)
object_store/src/lib.rs 86.75% <ø> (ø)
arrow/src/datatypes/types.rs 97.93% <100.00%> (+0.46%) ⬆️
arrow/src/datatypes/datatype.rs 62.30% <0.00%> (-0.32%) ⬇️
parquet_derive/src/parquet_field.rs 65.98% <0.00%> (+0.22%) ⬆️

Help us with your feedback. Take ten seconds to tell us how you rate us.

Copy link
Member

@Ted-Jiang Ted-Jiang left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice write up! 😊

@alamb
Copy link
Contributor Author

alamb commented Aug 2, 2022

Thanks @Ted-Jiang !

@alamb alamb merged commit 3e17891 into apache:master Aug 2, 2022
@alamb alamb deleted the alamb/object_store_example branch August 2, 2022 19:43
@ursabot
Copy link

ursabot commented Aug 2, 2022

Benchmark runs are scheduled for baseline = 6bb4b5e and contender = 3e17891. 3e17891 is a master commit associated with this PR. Results will be available as each benchmark for each run completes.
Conbench compare runs links:
[Skipped ⚠️ Benchmarking of arrow-rs-commits is not supported on ec2-t3-xlarge-us-east-2] ec2-t3-xlarge-us-east-2
[Skipped ⚠️ Benchmarking of arrow-rs-commits is not supported on test-mac-arm] test-mac-arm
[Skipped ⚠️ Benchmarking of arrow-rs-commits is not supported on ursa-i9-9960x] ursa-i9-9960x
[Skipped ⚠️ Benchmarking of arrow-rs-commits is not supported on ursa-thinkcentre-m75q] ursa-thinkcentre-m75q
Buildkite builds:
Supported benchmarks:
ec2-t3-xlarge-us-east-2: Supported benchmark langs: Python, R. Runs only benchmarks with cloud = True
test-mac-arm: Supported benchmark langs: C++, Python, R
ursa-i9-9960x: Supported benchmark langs: Python, R, JavaScript
ursa-thinkcentre-m75q: Supported benchmark langs: C++, Java

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation object-store Object Store Interface
Projects
None yet
Development

Successfully merging this pull request may close these issues.

object_store: Add example in the main documentation readme
5 participants