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

Remove doc hidden from GenericColumnReader #2090

Merged
merged 2 commits into from
Jul 16, 2022

Conversation

tustvold
Copy link
Contributor

Currently the lack of docs makes it hard to determine how to use ColumnReaderImpl - see here.

The decision was initially made to hide these docs to allow us to evolve the API, however, I think it makes sense to unhide this API because:

  • It should be relatively static now
  • As ColumnLevelDecoderImpl, etc... are still private, this change does not impact our ability to make breaking changes to them
  • We are making more frequent breaking releases than we were at the time this change was made

@@ -45,7 +45,6 @@ pub(crate) const MIN_BATCH_SIZE: usize = 1024;
pub type RecordReader<T> =
GenericRecordReader<ScalarBuffer<<T as DataType>::T>, ColumnValueDecoderImpl<T>>;

#[doc(hidden)]
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Drive by cleanup, this module is private and so there is no user-facing change

@github-actions github-actions bot added the parquet Changes to the parquet crate label Jul 16, 2022
@codecov-commenter
Copy link

codecov-commenter commented Jul 16, 2022

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 83.70%. Comparing base (a6379fe) to head (46d5b80).
Report is 2204 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #2090   +/-   ##
=======================================
  Coverage   83.70%   83.70%           
=======================================
  Files         224      224           
  Lines       58967    58967           
=======================================
  Hits        49360    49360           
  Misses       9607     9607           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@tustvold tustvold merged commit 13adaa7 into apache:master Jul 16, 2022
@ursabot
Copy link

ursabot commented Jul 16, 2022

Benchmark runs are scheduled for baseline = 1738a90 and contender = 13adaa7. 13adaa7 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
parquet Changes to the parquet crate
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants