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-35364: Flutter SDK - Nested Collections of Mixed Data #3201

Merged

Conversation

cbullinger
Copy link
Collaborator

@cbullinger cbullinger commented Mar 15, 2024

Pull Request Info

NOTE: This PR is temporarily using an alpha snapshot - unit tests will fail. Upgrading to v2.0.0 release, once it's available, may impact some of the code examples.

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

  • Define an Object Schema: Added new "Modeled Unstructured Data" section with example
  • Data Types: Updated RealmValue mixed data type section with new info and examples for collections in mixed; added note re. breaking change (links to migration page from a separate PR)
  • Read: Add new Query Nested Collections of Mixed Data (needs query examples added as part of RQL ticket)

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

  • Flutter SDK
    • Realm Database/Model Data/Define an Object Schema: New "Modeled Unstructured Data" section added with a tested, Bluehawked code example to document nested collections of mixed data.
    • Realm Database/Model Data/Data Types: RealmValue section updated to document the new support for nested collections of mixed data and additional changes to the data type. Tested, Bluehawked code examples were updated or added.
    • Realm Database/CRUD/Read: New "Query Nested Collections of Mixed Data" section added with a tested, Bluehawked code example to document new RQL queries for nested collections.

Review Guidelines

REVIEWING.md

Copy link

github-actions bot commented Mar 15, 2024

Readability for Commit Hash: a97a303

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

Readability scores for changed documents:

  • source/sdk/flutter/realm-database/model-data/data-types: Grade Level: 7.9, Reading Ease: 59.5
  • source/sdk/flutter/realm-database/model-data/define-realm-object-schema: Grade Level: 8.6, Reading Ease: 57.77
  • source/sdk/flutter/crud/read: Grade Level: 8.3, Reading Ease: 58.38

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

@nirinchev nirinchev left a comment

Choose a reason for hiding this comment

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

I haven't gone through the whole thing yet since it's quite late, but I'll get to it on Monday! I think the structure is sound, but we could come up with better examples. There are a few inaccuracies as well that I've highlighted.

@cbullinger cbullinger force-pushed the docsp-35364-dart-collections-mixed branch 5 times, most recently from 3351c2a to bc24393 Compare March 18, 2024 16:47
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.

Overall, content looks good! A few smaller suggestions and fixes.
For code snippets, I would like to see introduction comments to explain what the code is doing. Sometimes you explain what the code is doing in the text, sometimes not. I think an introduction comment is helpful whether the code is explained in text or not, given the code is copyable.

source/sdk/flutter/crud/read.txt Outdated Show resolved Hide resolved
Comment on lines +255 to +256
in the nested data and to update specific elements, but it is less
performant than using a structured schema or serializing JSON blobs
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
in the nested data and to update specific elements, but it is less
performant than using a structured schema or serializing JSON blobs
in the nested data and to update specific elements. However in some cases, it is less
performant than using a structured schema or serializing JSON blobs.

Why it is less performant? Maybe give some reasons or cases where it would be less performant.

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've noted this for a fast follow addition. I'll need to get more info from engineering for the additional details

@cbullinger cbullinger force-pushed the docsp-35364-dart-collections-mixed branch from 5e07cea to 5541428 Compare March 20, 2024 21:15
@cbullinger cbullinger force-pushed the docsp-35364-dart-collections-mixed branch from 5541428 to 7cf1966 Compare March 20, 2024 21:18
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.

Some typos and more stuff about comments, add at your discretion. Otherwise, LGTM!

source/sdk/flutter/crud/read.txt Outdated Show resolved Hide resolved
source/sdk/flutter/crud/read.txt Outdated Show resolved Hide resolved
source/sdk/flutter/crud/read.txt Outdated Show resolved Hide resolved
source/sdk/flutter/crud/read.txt Outdated Show resolved Hide resolved
source/sdk/flutter/crud/read.txt Show resolved Hide resolved
@cbullinger cbullinger force-pushed the docsp-35364-dart-collections-mixed branch 3 times, most recently from ce22f63 to 50f7a4b Compare March 21, 2024 14:19
@cbullinger cbullinger force-pushed the docsp-35364-dart-collections-mixed branch from 50f7a4b to 25bafda Compare March 21, 2024 14:22
@cbullinger cbullinger changed the base branch from dart-v2.0.0 to master March 21, 2024 14:23
@cbullinger cbullinger merged commit 4fe38a1 into mongodb:master Mar 21, 2024
6 checks passed
@cbullinger cbullinger deleted the docsp-35364-dart-collections-mixed branch March 21, 2024 15:09
@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.

4 participants