-
Notifications
You must be signed in to change notification settings - Fork 88
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-33121): C++: Update Sync error handling docs for v0.4.0-preview #3081
Conversation
Readability for Commit Hash: eec52a4 You can see any previous Readability scores (if they exist) by looking Readability scores for changed documents:
For Grade Level, aim for 8 or below. For Reading Ease scores, aim for 60 or above:
For help improving readability, try Hemingway App. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM with some non-blocking comments
Client Data Model and Configuration | ||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
|
||
Using the :ref:`object model <cpp-sync-example-object-model>`, the examples |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this may just be copying the other pages, but this link to the very previous section doesn't seem helpful to me. and the current wording is also a bit confusing: "the examples configure..."?
Using the :ref:`object model <cpp-sync-example-object-model>`, the examples | |
Using the example object model, the synced realm is configured to ... |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah, it is just copying the other pages, but I left this link here because the object model we're referencing was past all the App Services configuration stuff. So it wasn't directly above this code - it's a bit of a distance away. I wanted it to be easily accessible for someone who wanted to see it as it relates to the sync query.
I guess I could use a tab here to let people easily swap back and forth between the sync query and the object model, instead of making a link you have to click. Let me experiment with that...
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I replaced this with a tab, instead. What do you think of this approach, @cbullinger ? We aren't really doing this anywhere else in the docs and I'm undecided how I feel about it.
4851c3e
to
565f454
Compare
Co-authored-by: cbullinger <[email protected]>
565f454
to
390251a
Compare
✨ Staging URL: https://preview-mongodbmongodb.gatsbyjs.io/realm/master/ 🪵 Logs |
Pull Request Info
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.
Release Notes
realm::App(configuration)
.version changed
details throughout docs to specifyrealm::App(...)
deprecation in favor ofrealm::App(configuration)
in v0.4.0-preview.Review Guidelines
REVIEWING.md