fix: align API names with Swift guidelines - #20
Merged
Conversation
This file contains hidden or 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
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.
entry(for:)and the CLI command togetfor clearer use-site semantics.stringIdentifier,stringNamed, andlocate....Note
Medium Risk
Medium risk because it introduces breaking renames across the public Swift API and
xcdocsCLI subcommand, which can disrupt downstream callers despite minimal logic changes.Overview
Renames the exact-entry lookup surface from fetch to entry across the Swift API (
Client.fetch→Client.entry(for:)), the support layer (VectorSearchClient.fetch→entry(for:)), and the CLI (xcdocs fetch→xcdocs get), updating README and integration tests accordingly.Aligns internal/bridge naming with Swift conventions by replacing implementation-heavy terms (e.g.,
stringIdentifier→identifier,stringNamed→stringAttribute(named:),locateDatabaseDirectoryURL()→databaseDirectoryURL()), and adjusts related call sites/parameter labels (includingMADServiceObject.performRequests).Written by Cursor Bugbot for commit d8e3af8. This will update automatically on new commits. Configure here.