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

[#460][MINOR] docs: clarify deleteColumn doc #497

Merged
merged 2 commits into from
Oct 12, 2023

Conversation

mchades
Copy link
Contributor

@mchades mchades commented Oct 12, 2023

What changes were proposed in this pull request?

Update the documentation in deleteColumn to clarify the usage of ifExists.

Why are the changes needed?

It's unclear how ifExists works

Fix: #460

Does this PR introduce any user-facing change?

no

How was this patch tested?

UT added

@github-actions
Copy link

github-actions bot commented Oct 12, 2023

Code Coverage Report

Overall Project 62.58% 🟢
Module Coverage
api 68.43% 🟢
Files
Module File Coverage
api TableChange.java 85.09% 🟢

*
* @param fieldNames Field names of the column to delete.
* @param ifExists Silence the error if column doesn't exist during drop.
* @param ifExists If true, the change will succeed even if the field does not exist.
Copy link
Contributor

Choose a reason for hiding this comment

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

How about: "If true, silence the error if column doesn't exist during drop. Otherwise ..."

@jerryshao jerryshao merged commit c953f18 into apache:main Oct 12, 2023
1 check passed
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.

[Bug report] deleteColumn interface is unclear and doesn't work as expected
2 participants