Skip to content

Conversation

@waynexia
Copy link
Member

Which issue does this PR close?

Closes #.

Rationale for this change

I find (actually this is found by my typo ci) this typo "unqualifed" in our public API.

What changes are included in this PR?

Correct the typo

Are these changes tested?

Are there any user-facing changes?

Yes, this is a breaking change.

I'm not sure how we should handle this. Maybe add a new correct spelling method that proxies to the current implementation, and deprecate the typo one?

Further more, is it necessary to setup a typo CI in this repository as well 🤔

Signed-off-by: Ruihang Xia <waynestxia@gmail.com>
@github-actions github-actions bot added logical-expr Logical plan and expressions optimizer Optimizer rules core Core DataFusion crate labels Jun 28, 2024
@alamb alamb added the api change Changes the API exposed to users of the crate label Jun 28, 2024
@alamb
Copy link
Contributor

alamb commented Jun 28, 2024

Thanks @waynexia

I'm not sure how we should handle this. Maybe add a new correct spelling method that proxies to the current implementation, and deprecate the typo one?

I think that would be the most user friendly option if you can do so

Signed-off-by: Ruihang Xia <waynestxia@gmail.com>
@waynexia
Copy link
Member Author

Thanks @waynexia

I'm not sure how we should handle this. Maybe add a new correct spelling method that proxies to the current implementation, and deprecate the typo one?

I think that would be the most user friendly option if you can do so

Great. I removed it in c579528


/// Create a new `DFSchema` from a list of Arrow [Field]s
#[deprecated(
since = "40.0.0",
Copy link
Contributor

Choose a reason for hiding this comment

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

👍 wow what a typo

Co-authored-by: Oleks V <comphead@users.noreply.github.com>
Copy link
Contributor

@alamb alamb left a comment

Choose a reason for hiding this comment

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

Thank you @waynexia and @comphead

@waynexia waynexia merged commit c80da91 into apache:main Jun 29, 2024
@waynexia waynexia deleted the fix-typo-1 branch June 29, 2024 03:07
findepi pushed a commit to findepi/datafusion that referenced this pull request Jul 16, 2024
* fix(typo): unqualifed to unqualified

Signed-off-by: Ruihang Xia <waynestxia@gmail.com>

* keep the old API

Signed-off-by: Ruihang Xia <waynestxia@gmail.com>

* Update datafusion/common/src/dfschema.rs

Co-authored-by: Oleks V <comphead@users.noreply.github.com>

---------

Signed-off-by: Ruihang Xia <waynestxia@gmail.com>
Co-authored-by: Oleks V <comphead@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

api change Changes the API exposed to users of the crate core Core DataFusion crate logical-expr Logical plan and expressions optimizer Optimizer rules

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants