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

refactor: user Swift convention for parameter names #321

Merged
merged 4 commits into from
Jan 18, 2022

Conversation

cbaker6
Copy link
Contributor

@cbaker6 cbaker6 commented Jan 18, 2022

New Pull Request Checklist

Issue Description

Some naming in the SDK doesn't match Swift Style guide

Related issue: #n/a

Approach

Move to matching Swift Style Guide. Breaking, but the compiler should get most of these correct. Many people are probably not using most of these as they have default values...

Makes the following changes:

  • isUsingMongoDB -> usingMongoDB
  • isIgnoreCustomObjectIdConfig -> ignoringCustomObjectIdConfig
  • isUsingEQ -> usingEqComparator

TODOs before merging

  • Add entry to changelog
  • Add changes to documentation (guides, repository pages, in-code descriptions)

@parse-github-assistant
Copy link

parse-github-assistant bot commented Jan 18, 2022

Thanks for opening this pull request!

  • 🎉 We are excited about your hands-on contribution!

@codecov
Copy link

codecov bot commented Jan 18, 2022

Codecov Report

Merging #321 (9b9fa43) into main (22be4df) will decrease coverage by 0.01%.
The diff coverage is 100.00%.

Impacted file tree graph

@@            Coverage Diff             @@
##             main     #321      +/-   ##
==========================================
- Coverage   84.98%   84.96%   -0.02%     
==========================================
  Files         114      114              
  Lines       12049    12049              
==========================================
- Hits        10240    10238       -2     
- Misses       1809     1811       +2     
Impacted Files Coverage Δ
Sources/ParseSwift/API/API+Command.swift 84.64% <100.00%> (ø)
...s/ParseSwift/Objects/ParseInstallation+async.swift 100.00% <100.00%> (ø)
...ParseSwift/Objects/ParseInstallation+combine.swift 92.94% <100.00%> (ø)
Sources/ParseSwift/Objects/ParseInstallation.swift 82.36% <100.00%> (ø)
Sources/ParseSwift/Objects/ParseObject+async.swift 100.00% <100.00%> (ø)
...urces/ParseSwift/Objects/ParseObject+combine.swift 92.94% <100.00%> (ø)
Sources/ParseSwift/Objects/ParseObject.swift 82.29% <100.00%> (ø)
Sources/ParseSwift/Objects/ParseUser+async.swift 100.00% <100.00%> (ø)
Sources/ParseSwift/Objects/ParseUser+combine.swift 95.27% <100.00%> (ø)
Sources/ParseSwift/Objects/ParseUser.swift 82.45% <100.00%> (-0.19%) ⬇️
... and 5 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 22be4df...9b9fa43. Read the comment docs.

@cbaker6
Copy link
Contributor Author

cbaker6 commented Jan 18, 2022

@pmmlo can you look at this? I'm attempting to make the method signatures more swifty

@pmmlo
Copy link
Contributor

pmmlo commented Jan 18, 2022

@pmmlo can you look at this? I'm attempting to make the method signatures more swifty

Looks great! What an annoying refactor 😵‍💫

@cbaker6
Copy link
Contributor Author

cbaker6 commented Jan 18, 2022

Looks great! What an annoying refactor

I feel like these are always tricky to get right the first time. Since we have to introduce breaks in 4.0.0, might as well get them out of the way now.

I'm going to merge this one, but if you see other changes like this that should be made, can you open some PR's?

@pmmlo
Copy link
Contributor

pmmlo commented Jan 18, 2022

Looks great! What an annoying refactor

I feel like these are always tricky to get right the first time. Since we have to introduce breaks in 4.0.0, might as well get them out of the way now.

I'm going to merge this one, but if you see other changes like this that should be made, can you open some PR's?

Makes a lot of sense. Will try my best to help as I see them.

Thanks very much for another great release candidate!

@cbaker6 cbaker6 merged commit b1993c9 into parse-community:main Jan 18, 2022
@cbaker6 cbaker6 deleted the naming branch January 18, 2022 22:41
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.

None yet

2 participants