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-32718 - add comments #770

Merged

Conversation

mongoKart
Copy link
Collaborator

Pull Request Info

PR Reviewing Guidelines

JIRA - https://jira.mongodb.org/browse/DOCSP-32718
Staging:

Self-Review Checklist

  • Is this free of any warnings or errors in the RST?
  • Did you run a spell-check?
  • Did you run a grammar-check?
  • Are all the links working?

Copy link
Collaborator

@rustagir rustagir left a comment

Choose a reason for hiding this comment

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

Few things + questions!

@@ -7,9 +7,12 @@ const client = new MongoClient(uri);

Copy link
Collaborator

Choose a reason for hiding this comment

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

Q: I thought we were supposed to add code comments for the import statement and client creation as well -- Up to you if you want to add to the files throughout this PR.

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 saw those in the chat gpt example, but thought they were more like "this is a stop sign" than anything substantial.

source/code-snippets/crud/arrayFilters.js Outdated Show resolved Hide resolved
const query = { "entries.x": { $type : "string" } };

// For each matched element, increase value of y by 33
Copy link
Collaborator

Choose a reason for hiding this comment

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

I: I think this example only updates the first matching array element

Suggested change
// For each matched element, increase value of y by 33
// For the first matched array entry, increase value of y by 33

source/code-snippets/crud/arrayFilters.js Outdated Show resolved Hide resolved
source/code-snippets/crud/arrayFilters.js Outdated Show resolved Hide resolved
source/code-snippets/crud/arrayFilters.js Outdated Show resolved Hide resolved
source/code-snippets/usage-examples/distinct.js Outdated Show resolved Hide resolved
source/code-snippets/usage-examples/findOne.js Outdated Show resolved Hide resolved
source/code-snippets/usage-examples/replaceOne.js Outdated Show resolved Hide resolved
Comment on lines 8 to 9
async function run() {
try {
Copy link
Collaborator

Choose a reason for hiding this comment

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

Q: for the Usage examples that have JS and TS versions, should we update both?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Caitlin confirmed JS only

@mongoKart mongoKart requested a review from rustagir September 5, 2023 17:38
Copy link
Collaborator

@rustagir rustagir left a comment

Choose a reason for hiding this comment

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

lgtm!

@mongoKart mongoKart merged commit 11461c3 into mongodb:master Sep 5, 2023
mongoKart added a commit that referenced this pull request Sep 5, 2023
(cherry picked from commit 11461c3)
mongoKart added a commit that referenced this pull request Sep 5, 2023
(cherry picked from commit 11461c3)
mongoKart added a commit that referenced this pull request Sep 5, 2023
(cherry picked from commit 11461c3)
mongoKart added a commit that referenced this pull request Sep 5, 2023
(cherry picked from commit 11461c3)
mongoKart added a commit that referenced this pull request Sep 5, 2023
(cherry picked from commit 11461c3)
mongoKart added a commit that referenced this pull request Sep 5, 2023
(cherry picked from commit 11461c3)
mongoKart added a commit that referenced this pull request Sep 5, 2023
(cherry picked from commit 11461c3)
mongoKart added a commit that referenced this pull request Sep 5, 2023
(cherry picked from commit 11461c3)
mongoKart added a commit to mongoKart/docs-node that referenced this pull request Nov 3, 2023
caitlindavey added a commit that referenced this pull request Nov 26, 2024
* DOCSP-31824: Update page titles (#774)

(cherry picked from commit 9cd60b1)

* DOCSP-30081: Fix find to find()

* docsp-32718 - add comments (#770)

(cherry picked from commit 11461c3)

* Added code comments (#772) (#778)

(cherry picked from commit 5b0652a)

* removed nested components

* fixing bulkWrite

* Fixing bulkwrite

---------

Co-authored-by: Nora Reidy <[email protected]>
Co-authored-by: Mike Woofter <[email protected]>
Co-authored-by: Jordan Smith <[email protected]>
caitlindavey added a commit to caitlindavey/docs-node that referenced this pull request Nov 26, 2024
* DOCSP-31824: Update page titles (mongodb#774)

(cherry picked from commit 9cd60b1)

* DOCSP-30081: Fix find to find()

* docsp-32718 - add comments (mongodb#770)

(cherry picked from commit 11461c3)

* Added code comments (mongodb#772) (mongodb#778)

(cherry picked from commit 5b0652a)

* removed nested components

* fixing bulkWrite

* Fixing bulkwrite

---------

Co-authored-by: Nora Reidy <[email protected]>
Co-authored-by: Mike Woofter <[email protected]>
Co-authored-by: Jordan Smith <[email protected]>
(cherry picked from commit fa3f2bc)
caitlindavey added a commit that referenced this pull request Nov 26, 2024
* DOCSP-31824: Update page titles (#774)

(cherry picked from commit 9cd60b1)

* DOCSP-30081: Fix find to find()

* docsp-32718 - add comments (#770)

(cherry picked from commit 11461c3)

* Added code comments (#772) (#778)

(cherry picked from commit 5b0652a)

* removed nested components

* fixing bulkWrite

* Fixing bulkwrite

---------

Co-authored-by: Nora Reidy <[email protected]>
Co-authored-by: Mike Woofter <[email protected]>
Co-authored-by: Jordan Smith <[email protected]>
(cherry picked from commit fa3f2bc)
caitlindavey added a commit that referenced this pull request Nov 26, 2024
* DOCSP-31824: Update page titles (#774)

(cherry picked from commit 9cd60b1)

* DOCSP-30081: Fix find to find()

* docsp-32718 - add comments (#770)

(cherry picked from commit 11461c3)

* Added code comments (#772) (#778)

(cherry picked from commit 5b0652a)

* removed nested components

* fixing bulkWrite

* Fixing bulkwrite

---------

Co-authored-by: Nora Reidy <[email protected]>
Co-authored-by: Mike Woofter <[email protected]>
Co-authored-by: Jordan Smith <[email protected]>
(cherry picked from commit fa3f2bc)
caitlindavey added a commit that referenced this pull request Nov 26, 2024
* DOCSP-31824: Update page titles (#774)

(cherry picked from commit 9cd60b1)

* DOCSP-30081: Fix find to find()

* docsp-32718 - add comments (#770)

(cherry picked from commit 11461c3)

* Added code comments (#772) (#778)

(cherry picked from commit 5b0652a)

* removed nested components

* fixing bulkWrite

* Fixing bulkwrite

---------

Co-authored-by: Nora Reidy <[email protected]>
Co-authored-by: Mike Woofter <[email protected]>
Co-authored-by: Jordan Smith <[email protected]>
(cherry picked from commit fa3f2bc)
caitlindavey added a commit that referenced this pull request Nov 26, 2024
* DOCSP-31824: Update page titles (#774)

(cherry picked from commit 9cd60b1)

* DOCSP-30081: Fix find to find()

* docsp-32718 - add comments (#770)

(cherry picked from commit 11461c3)

* Added code comments (#772) (#778)

(cherry picked from commit 5b0652a)

* removed nested components

* fixing bulkWrite

* Fixing bulkwrite

---------

Co-authored-by: Nora Reidy <[email protected]>
Co-authored-by: Mike Woofter <[email protected]>
Co-authored-by: Jordan Smith <[email protected]>
(cherry picked from commit fa3f2bc)
caitlindavey added a commit that referenced this pull request Nov 26, 2024
* DOCSP-31824: Update page titles (#774)

(cherry picked from commit 9cd60b1)

* DOCSP-30081: Fix find to find()

* docsp-32718 - add comments (#770)

(cherry picked from commit 11461c3)

* Added code comments (#772) (#778)

(cherry picked from commit 5b0652a)

* removed nested components

* fixing bulkWrite

* Fixing bulkwrite

---------

Co-authored-by: Nora Reidy <[email protected]>
Co-authored-by: Mike Woofter <[email protected]>
Co-authored-by: Jordan Smith <[email protected]>
(cherry picked from commit fa3f2bc)
caitlindavey added a commit that referenced this pull request Nov 26, 2024
* DOCSP-31824: Update page titles (#774)

(cherry picked from commit 9cd60b1)

* DOCSP-30081: Fix find to find()

* docsp-32718 - add comments (#770)

(cherry picked from commit 11461c3)

* Added code comments (#772) (#778)

(cherry picked from commit 5b0652a)

* removed nested components

* fixing bulkWrite

* Fixing bulkwrite

---------

Co-authored-by: Nora Reidy <[email protected]>
Co-authored-by: Mike Woofter <[email protected]>
Co-authored-by: Jordan Smith <[email protected]>
(cherry picked from commit fa3f2bc)
caitlindavey added a commit that referenced this pull request Nov 26, 2024
* DOCSP-31824: Update page titles (#774)

(cherry picked from commit 9cd60b1)

* DOCSP-30081: Fix find to find()

* docsp-32718 - add comments (#770)

(cherry picked from commit 11461c3)

* Added code comments (#772) (#778)

(cherry picked from commit 5b0652a)

* removed nested components

* fixing bulkWrite

* Fixing bulkwrite

---------

Co-authored-by: Nora Reidy <[email protected]>
Co-authored-by: Mike Woofter <[email protected]>
Co-authored-by: Jordan Smith <[email protected]>
(cherry picked from commit fa3f2bc)
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.

2 participants