Skip to content

fix: Correct spelling and semantic mistakes in method naming #1970

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

Merged
merged 1 commit into from
Aug 1, 2023

Conversation

fishey2
Copy link
Contributor

@fishey2 fishey2 commented Jul 29, 2023

Change list

  • corrects spelling and semantic errors
    • SupportsCustomSslCertOption method setCustomSSLCert() is now getCustomSSLCert() affects XCUITestOptions
    • SupportsSimulatorTracePointerOption method doesSimulatorTracePointerd() is now doesSimulatorTracePointer() affects XCUITestOption
    • SupportsShowChromedriverLogOption methods setDhowChromedriverLog(boolean) and doesDhowChromedriverLog() are now setShowChromedriverLog(boolean) and doesShowChromedriverLog() respectively affects ExpressoOptions and UIAutomator2Options

Types of changes

What types of changes are you proposing/introducing to Java client?
Put an x in the boxes that apply

  • No changes in production code.
  • Bugfix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)

Details

No functional changes

@linux-foundation-easycla
Copy link

linux-foundation-easycla bot commented Jul 29, 2023

CLA Missing ID CLA Not Signed

@fishey2 fishey2 changed the title fix: Correct spelling and semantic mistakes in method naming (#1967) fix: Correct spelling and semantic mistakes in method naming Jul 29, 2023
@mykola-mokhnach
Copy link
Contributor

Could you please sign CLA?

@fishey2
Copy link
Contributor Author

fishey2 commented Jul 29, 2023

I should have now signed the CLA

@mykola-mokhnach
Copy link
Contributor

In order to not make this change breaking it would make sence to mark method names containing typos as @Deprecated and keep them for now along with corrected ones. We could remove deprecated methods in later releases.

@fishey2
Copy link
Contributor Author

fishey2 commented Jul 30, 2023

The changes should reflect your suggestion now @mykola-mokhnach: Deprecated rather than remove methods containing typos.

Copy link
Collaborator

@valfirst valfirst left a comment

Choose a reason for hiding this comment

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

@fishey2 would you mind fixing Checkstyle violations?

@fishey2
Copy link
Contributor Author

fishey2 commented Jul 31, 2023

@valfirst happy to work around the Checkstyle issue, however the actual checkstyle issue is apparent because it thinks the deprecated method setCustomSSLCert() overloads setCustomSSLCert(String) instead of getCustomSSLCert(), which should have been the case.

In this case there is only the two methods in the class and moving it up shouldn't affect anything else, but workaround the checkstyle issue. I will push this change now.

…1967)

 - affects SupportsCustomSslCertOption, SupportsShowChromedriverLogOption and SupportsSimulatorTracePointerOption
@mykola-mokhnach mykola-mokhnach merged commit 1f8d893 into appium:master Aug 1, 2023
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.

SupportsShowChromedriverLogOption contains apparent spelling mistakes in method naming
3 participants