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-35191): C++: Add details around REALM_SCHEMA and namespace realm #3149

Merged
merged 4 commits into from
Jan 10, 2024

Conversation

dacharyc
Copy link
Collaborator

@dacharyc dacharyc commented Jan 9, 2024

Pull Request Info

Jira ticket: https://jira.mongodb.org/browse/DOCSP-35191

  • Define an Object Model: Minor updates throughout the page for consistency, including naming updates. The main change as requested in the Jira ticket is in the "Define a New Object Type" section.
  • CRUD/Create: Explicitly mention that when you define a new object, you must do it using the realm namespace.

Reminder Checklist

Before merging your PR, make sure to check a few things.

  • Did you tag pages appropriately?
    • genre
    • meta.keywords
    • meta.description
  • Describe your PR's changes in the Release Notes section
  • Create a Jira ticket for related docs-app-services work, if any

Release Notes

  • *C++ SDK
    • Model Data/Define an Object Model: Add information and update code examples to show defining a model in the realm namespace.
    • CRUD/Create: Explicitly mention that when you define a new object, you must do it using the realm namespace.

Review Guidelines

REVIEWING.md

Copy link

github-actions bot commented Jan 9, 2024

Readability for Commit Hash: 7839116

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

Readability scores for changed documents:

  • source/sdk/cpp/model-data/object-models: Grade Level: 9.4, Reading Ease: 55.64
  • source/sdk/cpp/crud/create: Grade Level: 9.5, Reading Ease: 50.02

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

@cbullinger cbullinger left a comment

Choose a reason for hiding this comment

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

lgtm! simplifying to "database" and "object" is going to help with clarity, I think

source/sdk/cpp/model-data/object-models.txt Outdated Show resolved Hide resolved
source/sdk/cpp/model-data/object-models.txt Outdated Show resolved Hide resolved
- Remove an asymmetric object from a realm
- Query an asymmetric object
- Remove an asymmetric object from the device database
- Query an asymmetric object from the device database

You can only create an asymmetric object, which then syncs unidirectionally
to the Atlas database linked to your App with Device Sync.
Copy link
Collaborator

Choose a reason for hiding this comment

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

...if all sync databases are necessarily Atlas databases, is that a possible term we can use (the "device database" vs. the "Atlas database")?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I don't think I'm following this Q. Let's talk about this when we sync on naming updates so we're making consistent updates across the SDKs.

@dacharyc dacharyc merged commit 440b0ee into mongodb:master Jan 10, 2024
6 checks passed
@dacharyc dacharyc deleted the DOCSP-35191 branch January 10, 2024 17:01
@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