-
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-30804): Flutter: Break out CRUD section, List and Set asResults() #3121
Conversation
Readability for Commit Hash: dba85a9 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.
a couple suggestions, but overall LGTM once the staging build confirms the code example is displaying correctly
source/sdk/flutter/crud.txt
Outdated
Delete </sdk/flutter/crud/delete> | ||
|
||
- :doc:`Create </sdk/flutter/crud/create>` | ||
- :doc:`Create </sdk/flutter/crud/read>` |
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.
- :doc:`Create </sdk/flutter/crud/read>` | |
- :doc:`Read </sdk/flutter/crud/read>` |
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.
Bah, where was my attention to detail? Thank you for catching this!
config/redirects
Outdated
|
||
# Flutter swarm/parity | ||
|
||
raw: ${prefix}/sdk/flutter/realm-database/read-and-write-data -> ${base}/sdk/flutter/realm-database/crud/create |
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.
raw: ${prefix}/sdk/flutter/realm-database/read-and-write-data -> ${base}/sdk/flutter/realm-database/crud/create | |
raw: ${prefix}/sdk/flutter/realm-database/read-and-write-data -> ${base}/sdk/flutter/realm-database/crud/create/ |
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.
Blah, good catch, thank you!
'Rescuing short stormtroopers' | ||
]), | ||
Person(ObjectId(), 'Han', | ||
hobbies: ['Shooting first', 'Making fast Kessel Runs']), |
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.
reformat for consistency with the others?
Person(ObjectId(), 'Han', hobbies: [
'Shooting first',
'Making fast Kessel Runs'
]),
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 couldn't do that even if I tried - this is all the linter, baybee. Upside/downside of using a linter.
2a1e713
to
5f6122a
Compare
✨ Staging URL: https://preview-mongodbmongodb.gatsbyjs.io/realm/master/ 🪵 Logs |
Pull Request Info
Jira ticket: https://jira.mongodb.org/browse/DOCSP-30804
As part of this PR, I also broke out the Read & Write Data page into a new CRUD section. I put it at the root of the SDK because a future iteration will remove the "Realm Database" docs from the "Realm Database" section of the SDK. Putting it at the root of the SDK means we won't have to make redirects for this section when that time comes - we'll only have to update the ToC.
I copied language that has already been approved in the C++ and Kotlin SDKs to flesh out CRUD details. The only changes I made to that language was to update the SDK docs links referenced, and to omit Realm naming when possible in favor of the new naming/positioning.
Reminder Checklist
Before merging your PR, make sure to check a few things.
Release Notes
Review Guidelines
REVIEWING.md