minor: fix typos in comments / structure names #13879
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
github-actions
bot
added
sql
alamb
approved these changes
Dec 22, 2024
There was a problem hiding this comment.
Thank you for the contrbibution @zhuliquan - this looks like a great improvement ❤️ and will make the code easier to read and understand,.
datafusion-cli/src/main.rs
Outdated
| @@ -209,7 +209,7 @@ async fn main_inner() -> Result<()> { | |||
| if !rc.is_empty() { | |||
| exec::exec_from_files(&ctx, rc, &print_options).await?; | |||
| } | |||
| // TODO maybe we can have thiserror for cli but for now let's keep it simple | |||
| // TODO maybe we can have this error for cli but for now let's keep it simple | |||
There was a problem hiding this comment.
I think technically thiserror refers to https://crates.io/crates/thiserror
There was a problem hiding this comment.
Ok, I got it, I will recover it
| @@ -211,7 +211,7 @@ async fn main() -> Result<()> { | |||
| // | |||
| // Note: in order to prune pages, the Page Index must be loaded and the | |||
| // ParquetExec will load it on demand if not present. To avoid a second IO | |||
| // during query, this example loaded the Page Index pre-emptively by setting | |||
| // during query, this example loaded the Page Index pre-emptily by setting | |||
There was a problem hiding this comment.
I think this is actually meant to be something different:
Suggested change
| // during query, this example loaded the Page Index pre-emptily by setting | |
| // during query, this example loaded the Page Index preemptively by setting |
There was a problem hiding this comment.
Yeah, I got it, I will recover it
| @@ -115,7 +115,7 @@ pub trait Accumulator: Send + Sync + Debug { | |||
| /// │ │ | |||
| /// │ │ | |||
| /// ┌─────────────────────────┐ ┌─────────────────────────┐ | |||
| /// │ GroubyBy │ │ GroubyBy │ | |||
| /// │ GroupBy │ │ GroupBy │ | |||
| @@ -36,7 +36,7 @@ use datafusion_expr::{ | |||
| TableScan, Window, | |||
| }; | |||
|
|
|||
| use crate::optimize_projections::required_indices::RequiredIndicies; | |||
| use crate::optimize_projections::required_indices::RequiredIndices; | |||
There was a problem hiding this comment.
Since this is an internal struct (not exposed publically) I think this is not an API change: https://docs.rs/datafusion/latest/datafusion/index.html?search=RequiredIndicies
| @@ -35,15 +35,15 @@ use datafusion_expr::{Expr, LogicalPlan}; | |||
| /// indices were added `[3, 2, 4, 3, 6, 1]`, the instance would be represented | |||
| /// by `[1, 2, 3, 4, 6]`. | |||
| #[derive(Debug, Clone, Default)] | |||
| pub(super) struct RequiredIndicies { | |||
| pub(super) struct RequiredIndices { | |||
There was a problem hiding this comment.
See above -- this is an internal struct so renaming it is not an API change
alamb
changed the title
github-actions
bot
removed
the
documentation
alamb
changed the title
| @@ -144,8 +144,8 @@ impl DirSchema { | |||
| async fn create(state: &SessionState, opts: DirSchemaOpts<'_>) -> Result<Arc<Self>> { | |||
| let DirSchemaOpts { ext, dir, format } = opts; | |||
| let mut tables = HashMap::new(); | |||
| let direntries = std::fs::read_dir(dir).unwrap(); | |||
| for res in direntries { | |||
| let directories = std::fs::read_dir(dir).unwrap(); | |||
| @@ -170,7 +170,7 @@ impl RepartitionExecState { | |||
| /// which is commonly set to the number of CPU cores and all call execute at the same time. | |||
| /// | |||
| /// Thus, use a **tokio** `OnceCell` for this initialization so as not to waste CPU cycles | |||
| /// in a futex lock but instead allow other threads to do something useful. | |||
There was a problem hiding this comment.
futex word might be correct here
|
Thanks again @zhuliquan and @berkaysynnada 🚀 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Which issue does this PR close?
Closes #.
Rationale for this change
fix some typo error in doc
What changes are included in this PR?
fix some typo error in doc
Are these changes tested?
Are there any user-facing changes?
no