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

chore: flatter exports, docs fixes and README header #609

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

roeap
Copy link
Collaborator

@roeap roeap commented Dec 19, 2024

What changes are proposed in this pull request?

Some small docs fixes. E.g. while docs.rs seems to render links fine when the reference is also wrapped backticks - [something]: ... - rust analyzer does not recognize this, and requires a "plain" name.

The architecture and roadmap document in the doc/ folder seemed grossly outdated and of little value, so I removed them.

Also wanted to propose some flair for the Readme :).

This PR affects the following public APIs

While there are no actual API changes, some structs can now be imported (IMO) more conveniently. Building out the datafusion integration, I found myself frequently having to write deep imports - e.g.

// before
use delta_kernel::engine::default::executor::tokio::TokioBackgroundExecutor;

// after
use delta_kernel::engine::default::TokioBackgroundExecutor;

How was this change tested?

current tests + rendering and inspecting docs with

cargo doc -p delta_kernel --all-features

@roeap
Copy link
Collaborator Author

roeap commented Dec 19, 2024

interesting, docs build seems to fail now, while it did work locally... I'll see whats going on.

@roeap roeap marked this pull request as draft December 19, 2024 15:09
Copy link

codecov bot commented Dec 19, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 83.45%. Comparing base (c3a868f) to head (7e5d374).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #609   +/-   ##
=======================================
  Coverage   83.45%   83.45%           
=======================================
  Files          74       74           
  Lines       16877    16877           
  Branches    16877    16877           
=======================================
  Hits        14084    14084           
  Misses       2135     2135           
  Partials      658      658           

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

@@ -16,14 +16,14 @@ use crate::engine::arrow_data::ArrowEngineData;
use crate::{DeltaResult, FileDataReadResultIterator, FileMeta};

/// A fallible future that resolves to a stream of [`RecordBatch`]
/// cbindgen:ignore
// cbindgen:ignore
Copy link
Collaborator

Choose a reason for hiding this comment

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

// comments are unceremoniously stripped out by the parser and disappear.
/// comments become annotations that cbindgen can actually see and work with.

I agree it's unfortunate that this pollutes the public docs, tho.

@roeap roeap marked this pull request as ready for review December 20, 2024 10:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants