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-30804): Flutter: Break out CRUD section, List and Set asResults() #3121

Merged
merged 6 commits into from
Dec 20, 2023

Conversation

dacharyc
Copy link
Collaborator

@dacharyc dacharyc commented Dec 20, 2023

Pull Request Info

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

  • CRUD/Read: New "Convert Lists or Sets to Results" section with tested, Bluehawked code example demonstrating the functionality.

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.

  • 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/Realm Database/Read & Write Data: Break out the single page to a new CRUD section.
    • Realm/Realm Database/CRUD/Read: New "Convert Lists or Sets to Results" section with tested, Bluehawked code example demonstrating the functionality.

Review Guidelines

REVIEWING.md

Copy link

github-actions bot commented Dec 20, 2023

Readability for Commit Hash: dba85a9

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: Grade Level: 8.3, Reading Ease: 58.38
  • source/sdk/flutter/realm-database: Grade Level: 21.9, Reading Ease: -41.73
  • source/sdk/flutter/quick-start: Grade Level: 8.1, Reading Ease: 58.89
  • source/sdk/flutter/crud: Grade Level: 15.5, Reading Ease: -3.32
  • source/sdk/flutter/crud/update: Grade Level: 9.0, Reading Ease: 51.24
  • source/sdk/flutter/crud/read: Grade Level: 8.6, Reading Ease: 57.67
  • source/sdk/flutter/crud/delete: Grade Level: 4.4, Reading Ease: 79.26
  • source/sdk/flutter/crud/create: Grade Level: 7.2, Reading Ease: 66.64
  • source/sdk/cpp/crud: Grade Level: 14.7, Reading Ease: 9.55

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.

a couple suggestions, but overall LGTM once the staging build confirms the code example is displaying correctly

Delete </sdk/flutter/crud/delete>

- :doc:`Create </sdk/flutter/crud/create>`
- :doc:`Create </sdk/flutter/crud/read>`
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
- :doc:`Create </sdk/flutter/crud/read>`
- :doc:`Read </sdk/flutter/crud/read>`

Copy link
Collaborator Author

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
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
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/

Copy link
Collaborator Author

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']),
Copy link
Collaborator

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'
]),

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 couldn't do that even if I tried - this is all the linter, baybee. Upside/downside of using a linter.

examples/dart/test/read_write_data_test.dart Outdated Show resolved Hide resolved
examples/dart/test/read_write_data_test.dart Outdated Show resolved Hide resolved
examples/dart/test/read_write_data_test.dart Show resolved Hide resolved
@dacharyc dacharyc merged commit a272d29 into mongodb:master Dec 20, 2023
6 checks passed
@dacharyc dacharyc deleted the DOCSP-30804 branch December 20, 2023 22:59
@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