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

(DOCSP-34055): Swift: Add docs for wait for upload/download #3076

Merged
merged 6 commits into from
Dec 18, 2023

Conversation

dacharyc
Copy link
Collaborator

@dacharyc dacharyc commented Nov 10, 2023

Pull Request Info

While the eng PR this documents has been merged to master, it is not yet released. Wait for the next release before publishing. Before publishing:

  • Update Realm Swift to the release version
  • Add links to the API reference docs

Jira

Staged Changes

Reminder Checklist

If your PR modifies the docs, you might need to also update some corresponding
pages. Check if completed or N/A.

  • Create Jira ticket for corresponding docs-app-services update(s), if any
  • Checked/updated Admin API
  • Checked/updated CLI reference

Release Notes

  • Swift SDK
    • Sync Data/Manage Sync Sessions: New "Wait for Changes to Upload or Download" section with Bluehawked, tested code examples.

Review Guidelines

REVIEWING.md

Copy link

github-actions bot commented Nov 10, 2023

Readability for Commit Hash: 98634c9

You can see any previous Readability scores (if they exist) by looking
at the comment's history.

Readability scores for changed documents:

  • source/sdk/swift/sync/sync-session: Grade Level: 8.4, Reading Ease: 58.08

For Grade Level, aim for 8 or below.

For Reading Ease scores, aim for 60 or above:

Score Difficulty
90-100 Very Easy
80-89 Easy
70-79 Fairly Easy
60-69 Medium
50-59 Fairly Hard
30-49 Hard
0-29 Very Hard

For help improving readability, try Hemingway App.

Copy link
Collaborator

@lindseymoore lindseymoore left a comment

Choose a reason for hiding this comment

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

Small comments, LGTM!


You can use these methods with Swift's async/await syntax, or with the
callback syntax. The callback version can take a queue to dispatch the
callback onto, and a block to invoke when waiting is complete.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
callback onto, and a block to invoke when waiting is complete.
and a block to invoke when waiting is complete.


You can use these methods with Swift's async/await syntax, or with the
callback syntax. The callback version can take a queue to dispatch the
callback onto, and a block to invoke when waiting is complete.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
callback onto, and a block to invoke when waiting is complete.
and a block to invoke when waiting is complete.

``realm.syncSession?.wait(for: .download)``.

You can use these methods with Swift's async/await syntax, or with the
callback syntax. The callback version can take a queue to dispatch the
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
callback syntax. The callback version can take a queue to dispatch the
callback syntax. The callback version can take a queue for callbacks

Optional edit for clarity, continued in next comment. Think "queue to dispatch the callback onto" is unnecessarily complex.

@dacharyc dacharyc merged commit f187a41 into mongodb:master Dec 18, 2023
6 checks passed
@dacharyc dacharyc deleted the DOCSP-34055 branch December 18, 2023 18:33
@docs-builder-bot
Copy link

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.

3 participants