(DOCSP-26983): @realm/react-ify "Sets - React Native SDK" #2477

mohammadhunan-dev · 2023-01-10T15:39:27Z

Pull Request Info

Jira

https://jira.mongodb.org/browse/DOCSP-26983

Staged Changes

Sets - React Native SDK

Reminder Checklist

If your PR modifies the docs, you might need to also update some corresponding
pages. Check if completed or N/A.

[N/A] Create Jira ticket for corresponding docs-app-services update(s), if any
[N/A] Checked/updated Admin API
[N/A] Checked/updated CLI reference

Review Guidelines

REVIEWING.md

github-actions · 2023-01-10T15:41:05Z

Readability for Commit Hash: 2ddcf12

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

Flesch Reading Ease scores for changed documents:

source/sdk/react-native/realm-database/schemas/sets: 47.59

The following table can be helpful in assessing the readability score of a document.

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

cbullinger

A couple small things but overall lgtm

source/sdk/react-native/realm-database/schemas/sets.txt

cbullinger · 2023-01-17T13:24:07Z

source/sdk/react-native/realm-database/schemas/sets.txt

@@ -31,8 +31,23 @@ To define a property type as a ``Realm Set``, specify the data type
 you want in the set, followed by ``<>``. For instance, for a set made of integer
 values, specify ``"int<>"``. 


Suggested change

values, specify ``"int<>"``.

values, specify ``'int<>'``.

source/sdk/react-native/realm-database/schemas/sets.txt

cbullinger · 2023-01-17T13:30:23Z

source/sdk/react-native/realm-database/schemas/sets.txt

+Example
+~~~~~~~
+
+In the following example of a ``QueryCharacterInventory`` component we check the character's inventory size and if it has a specific item.


Suggested change

In the following example of a ``QueryCharacterInventory`` component we check the character's inventory size and if it has a specific item.

In the following example of a ``QueryCharacterInventory`` component, we check the character's inventory size and if it has a specific item.

cbullinger · 2023-01-17T13:40:17Z

source/sdk/react-native/realm-database/schemas/sets.txt

+- Creates a `state variable <https://reactjs.org/docs/hooks-state.html>`__ called "inventory" that will hold the character's inventory items in order of insertion.
+- Retrieves the character by passing the ``Character`` class to the ``useQuery()`` hook and running the :js-sdk:`Collection.filtered() <Realm.Collection.html#filtered>` method on the result to filter for characters with the name matching the ``characterName`` prop. Then we set the variable ``character`` to the first matching result.
+- Creates a component method ``addInventoryItem()`` that performs a write transaction that adds an inventory item to the character's inventory by passing the ``inventoryItem`` state variable to the :js-sdk:`Realm.Set.add() <Realm.Set.html#add>` method. After the write transaction, the method adds the ``inventoryItem`` to the ``inventory`` array state variable.
+- Renders a ``TextInput`` that changes the ``inventoryItem`` state variable, and a ``Button`` that calls the ``addInventoryItem()`` method.


Suggested change

- Renders a ``TextInput`` that changes the ``inventoryItem`` state variable, and a ``Button`` that calls the ``addInventoryItem()`` method.

- Renders a ``TextInput`` that changes the ``inventoryItem`` state variable, and renders a ``Button`` that calls the ``addInventoryItem()`` method.

(same as earlier - could also remove the comma or "Renders a TextInput... as well as a Button...")

cbullinger · 2023-01-17T13:47:10Z

source/sdk/react-native/realm-database/schemas/sets.txt

+- Creates a `state variable <https://reactjs.org/docs/hooks-state.html>`__ called "inventoryItem" that represents the inventory item to remove from the inventory set.
+- Creates a component method ``removeInventoryItem`` that passes the ``inventoryItem`` state variable to the :js-sdk:`Realm.Set.delete() <Realm.Set.html#delete>` method to remove the item from the character's inventory.
+- Creates a component method ``removeAllInventory`` that calls the :js-sdk:`Realm.Set.clear() <Realm.Set.html#clear>` method to remove all items from the character's inventory.
+- Renders a ``TextInput`` that changes the ``inventoryItem`` state variable, and two ``Button``s that call the ``removeInventoryItem`` and ``removeAllInventory`` methods, respectively. 


Suggested change

- Renders a ``TextInput`` that changes the ``inventoryItem`` state variable, and two ``Button``s that call the ``removeInventoryItem`` and ``removeAllInventory`` methods, respectively.

- Renders a ``TextInput`` that changes the ``inventoryItem`` state variable and two ``Button``s that call the ``removeInventoryItem`` and ``removeAllInventory`` methods, respectively.

Also, you'll need to change how you refer to the plural Buttons. The closing backticks aren't being recognized because of the s, so the formatting is incorrectly applied to all of the following text: Button` `s that call the removeInventoryItem

Good catch, referring to them here as: two Button components

cbullinger · 2023-01-17T13:50:20Z

source/sdk/react-native/realm-database/schemas/sets.txt


-   .. literalinclude:: /examples/generated/node/data-types.snippet.make-array-with-insertion-order-from-set.js
-      :language: javascript
+However, by default the order of the items in a set is not guaranteed. To


Suggested change

However, by default the order of the items in a set is not guaranteed. To

However, the order of the items in a set is not guaranteed by default. To

cbullinger · 2023-01-17T13:50:35Z

source/sdk/react-native/realm-database/schemas/sets.txt

+Example
+~~~~~~~
+
+In the following example of a ``TraverseCharacterInventory`` component a


Suggested change

In the following example of a ``TraverseCharacterInventory`` component a

In the following example of a ``TraverseCharacterInventory`` component, a

cbullinger · 2023-01-17T13:54:04Z

source/sdk/react-native/realm-database/schemas/sets.txt

+
+- Gets access to an opened realm instance by calling the ``useRealm()`` hook within the component. 
+- Creates a `state variable <https://reactjs.org/docs/hooks-state.html>`__ called "inventoryItem" that represents the new inventory item to add to the inventory set.
+- Retrieves the character by passing the ``Character`` class to the ``useQuery()`` hook and running the :js-sdk:`Collection.filtered() <Realm.Collection.html#filtered>` method on the result to filter for characters with the name matching the ``characterName`` prop. Then we set the variable ``character`` to the first matching result.


Suggested change

- Retrieves the character by passing the ``Character`` class to the ``useQuery()`` hook and running the :js-sdk:`Collection.filtered() <Realm.Collection.html#filtered>` method on the result to filter for characters with the name matching the ``characterName`` prop. Then we set the variable ``character`` to the first matching result.

- Retrieves the character by passing the ``Character`` class to the ``useQuery()`` hook and running the :js-sdk:`Collection.filtered() <Realm.Collection.html#filtered>` method on the result to filter for characters with the name matching the ``characterName`` `prop <https://reactjs.org/docs/components-and-props.html>`__. Then we set the variable ``character`` to the first matching result.

Co-authored-by: cbullinger <[email protected]>

## Pull Request Info ### Jira - https://jira.mongodb.org/browse/DOCSP-26983 ### Staged Changes - [Sets - React Native SDK](https://docs-mongodbcom-staging.corp.mongodb.com/realm/docsworker-xlarge/DOCSP-26983-realmset/sdk/react-native/realm-database/schemas/sets/) ### Reminder Checklist If your PR modifies the docs, you might need to also update some corresponding pages. Check if completed or N/A. - [N/A] Create Jira ticket for corresponding docs-app-services update(s), if any - [N/A] Checked/updated Admin API - [N/A] Checked/updated CLI reference ### Review Guidelines [REVIEWING.md](https://github.com/mongodb/docs-realm/blob/master/REVIEWING.md) Co-authored-by: Mohammad Hunan Chughtai <[email protected]> Co-authored-by: cbullinger <[email protected]>

takameyer

Cool examples here. I have some suggestions to clean things up a bit.

takameyer · 2023-02-27T08:17:12Z

examples/react-native/__tests__/js/Models/Character.js

+    properties: {
+      _id: 'objectId',
+      name: 'string',
+      levelsCompleted: 'int<>',


As stated in other PRs, I think it's worthwhile to show both the shorthand and object notation for defining schema properties:

levelsCompleted: { type: "set", objectType: "int" }

takameyer · 2023-02-27T08:20:56Z

source/sdk/react-native/realm-database/schemas/sets.txt

+
+Check if a Set has Specific Items and Check the Size of a Set
+-------------------------------------------------------------
+You may want to check for information about your set, such as the set's size or


Suggested change

You may want to check for information about your set, such as the set's size or

You may want to check for information about your ``Set``, such as the ``Set``'s size or

I think it would be good to keep refering to Set similarly throughout the document, so that it's clear we are talking about the Set data type

This should be checked throughout the entire document. It's not just here

takameyer · 2023-02-27T08:21:56Z

source/sdk/react-native/realm-database/schemas/sets.txt


-Check if a Set has Specific Items
---------------------------------
 To determine if a set contains a particular value, pass the value to the ``<Realm.Set>.has()`` method. The


set.has is refered to differently twice in this paragraph. This should be unified.

## Pull Request Info ### Jira - https://jira.mongodb.org/browse/DOCSP-26983 ### Staged Changes - [Sets - React Native SDK](https://docs-mongodbcom-staging.corp.mongodb.com/realm/docsworker-xlarge/DOCSP-26983-realmset/sdk/react-native/realm-database/schemas/sets/) ### Reminder Checklist If your PR modifies the docs, you might need to also update some corresponding pages. Check if completed or N/A. - [N/A] Create Jira ticket for corresponding docs-app-services update(s), if any - [N/A] Checked/updated Admin API - [N/A] Checked/updated CLI reference ### Review Guidelines [REVIEWING.md](https://github.com/mongodb/docs-realm/blob/master/REVIEWING.md) Co-authored-by: Mohammad Hunan Chughtai <[email protected]> Co-authored-by: cbullinger <[email protected]>

init set test

4610a83

mohammadhunan-dev changed the base branch from master to realm-react-guidance January 11, 2023 16:50

Mohammad Hunan Chughtai added 2 commits January 11, 2023 16:43

added unit test + rST up to add items to a set

e03ee8e

added copy for delete examples

e6b76bf

mohammadhunan-dev changed the title ~~WIP - Docsp 26983 realmset~~ WIP - (DOCSP-26983): @realm/react-ify "Sets - React Native SDK" Jan 11, 2023

Mohammad Hunan Chughtai added 2 commits January 12, 2023 13:36

added + skipped traverse test

1d32293

added traverse examples

7ea2f81

mohammadhunan-dev changed the title ~~WIP - (DOCSP-26983): @realm/react-ify "Sets - React Native SDK"~~ (DOCSP-26983): @realm/react-ify "Sets - React Native SDK" Jan 13, 2023

cbullinger approved these changes Jan 17, 2023

View reviewed changes

Mohammad Hunan Chughtai and others added 10 commits January 18, 2023 13:59

Update source/sdk/react-native/realm-database/schemas/sets.txt

d4a36d3

Co-authored-by: cbullinger <[email protected]>

Update source/sdk/react-native/realm-database/schemas/sets.txt

57431ff

Co-authored-by: cbullinger <[email protected]>

Update source/sdk/react-native/realm-database/schemas/sets.txt

8ec1b58

Co-authored-by: cbullinger <[email protected]>

grammar fixes

1b16643

wording fix

e013a01

add link about prop

992fbbe

fix line emphasis

c78eb6a

ran prettier + fixed missing timeout

6eaebe3

renamed mixed-tests.jsx -> mixed-test.jsx

7d6dbda

Merge branch 'realm-react-guidance' into DOCSP-26983-realmset

2ddcf12

mohammadhunan-dev merged commit eb10407 into mongodb:realm-react-guidance Jan 18, 2023

krollins-mdb requested a review from takameyer February 22, 2023 17:09

takameyer suggested changes Feb 27, 2023

View reviewed changes

		@@ -31,8 +31,23 @@ To define a property type as a ``Realm Set``, specify the data type
		you want in the set, followed by ``<>``. For instance, for a set made of integer
		values, specify ``"int<>"``.

	In the following example of a ``QueryCharacterInventory`` component we check the character's inventory size and if it has a specific item.
	In the following example of a ``QueryCharacterInventory`` component, we check the character's inventory size and if it has a specific item.

	- Renders a ``TextInput`` that changes the ``inventoryItem`` state variable, and a ``Button`` that calls the ``addInventoryItem()`` method.
	- Renders a ``TextInput`` that changes the ``inventoryItem`` state variable, and renders a ``Button`` that calls the ``addInventoryItem()`` method.

	However, by default the order of the items in a set is not guaranteed. To
	However, the order of the items in a set is not guaranteed by default. To

	In the following example of a ``TraverseCharacterInventory`` component a
	In the following example of a ``TraverseCharacterInventory`` component, a

	- Retrieves the character by passing the ``Character`` class to the ``useQuery()`` hook and running the :js-sdk:`Collection.filtered() <Realm.Collection.html#filtered>` method on the result to filter for characters with the name matching the ``characterName`` prop. Then we set the variable ``character`` to the first matching result.
	- Retrieves the character by passing the ``Character`` class to the ``useQuery()`` hook and running the :js-sdk:`Collection.filtered() <Realm.Collection.html#filtered>` method on the result to filter for characters with the name matching the ``characterName`` `prop <https://reactjs.org/docs/components-and-props.html>`__. Then we set the variable ``character`` to the first matching result.

	You may want to check for information about your set, such as the set's size or
	You may want to check for information about your ``Set``, such as the ``Set``'s size or

(DOCSP-26983): @realm/react-ify "Sets - React Native SDK" #2477

(DOCSP-26983): @realm/react-ify "Sets - React Native SDK" #2477

Uh oh!

Conversation

mohammadhunan-dev commented Jan 10, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Pull Request Info

Jira

Staged Changes

Reminder Checklist

Review Guidelines

Uh oh!

github-actions bot commented Jan 10, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

cbullinger left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mohammadhunan-dev Jan 18, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

takameyer left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

mohammadhunan-dev commented Jan 10, 2023 •

edited

Loading

github-actions bot commented Jan 10, 2023 •

edited

Loading

mohammadhunan-dev Jan 18, 2023 •

edited

Loading