refactor: rename Read trait functions for alignment #27
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
cdbrkfxrpt
force-pushed
the
flrn/rename-read-functions
branch
3 times, most recently
from
602e44e
to
9b2ca37
Compare
cdbrkfxrpt
force-pushed
the
flrn/rename-read-functions
branch
from
9b2ca37
to
dc9afc8
Compare
ntrinquier
approved these changes
Jun 29, 2024
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.
The CUD subset of the CRUD traits have function names corresponding to their trait names:
CreatehascreateUpdatehasupdateDeletehasdelete(anddelete_by)This PR aligns the function names of the
Readtrait:Read::find-->Read::readRead::find_optional-->Read::find(because it returns anOption<T>, it actually does have "search"/"find" semanticsIt also renames
Update::savetoUpdate::upsert, since the docs forUpdate::saveliterally said that this function has "upsert semantics".Happy to discuss all of the above! I'd also be happy with
getterminology, but in that case it would be cool if we could also rename the trait so there is always an "expectable" relationship between trait name and function names.(There is also some further cleanup here.)