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: add additional documentation about BufWriter #5519

Merged
merged 4 commits into from
Mar 16, 2024

Conversation

alamb
Copy link
Contributor

@alamb alamb commented Mar 15, 2024

Which issue does this PR close?

Closes #.

Rationale for this change

Inspired by apache/datafusion#9614, I wanted to make it clearer that BufWriter existed / what it could do

What changes are included in this PR?

  1. Update main lib docs to mention BufReader and BufWriter
  2. Update docs for BufReader to mention it adaptively used put / put multi-part

Are there any user-facing changes?

Docs

No code / behavior changes

@alamb alamb added documentation Improvements or additions to documentation object-store Object Store Interface labels Mar 15, 2024
@alamb alamb changed the title Minor: add additional documentation about BufWriter Minor: add additional documentation about BufWriter Mar 15, 2024
@@ -207,6 +207,10 @@ impl AsyncBufRead for BufReader {

/// An async buffered writer compatible with the tokio IO traits
///
/// This writer adaptively uses [`ObjectStore::put`] or
Copy link
Contributor Author

Choose a reason for hiding this comment

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

this is such an important feature I think it is worth calling out explicitly

object_store/src/buffered.rs Outdated Show resolved Hide resolved
@alamb alamb marked this pull request as ready for review March 15, 2024 13:39
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.

Just a minor copy suggestion, I think we should highlight that they're a compatibility tool and not hugely recommended

object_store/src/lib.rs Outdated Show resolved Hide resolved
object_store/src/lib.rs Outdated Show resolved Hide resolved
alamb and others added 2 commits March 15, 2024 16:38
@tustvold tustvold merged commit f41c2a4 into apache:master Mar 16, 2024
13 checks passed
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.

2 participants