Skip to content

DOCSP-33345: Java code comments pt. 2 #470

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

Merged
merged 3 commits into from
Oct 18, 2023

Conversation

norareidy
Copy link
Contributor

@norareidy norareidy commented Oct 9, 2023

Copy link
Collaborator

@caitlindavey caitlindavey left a comment

Choose a reason for hiding this comment

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

Added a few comments, but LGTM

Comment on lines 1 to 5
/**
* This file demonstrates how to find distinct values of a field by using the Java driver.
* It connects to a MongoDB deployment, accesses the "sample_mflix" database, and finds
* distinct "year" values for documents that match the specified query filter.
*/
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
/**
* This file demonstrates how to find distinct values of a field by using the Java driver.
* It connects to a MongoDB deployment, accesses the "sample_mflix" database, and finds
* distinct "year" values for documents that match the specified query filter.
*/
// Find distinct values of a field by using the MongoDB Java driver

Comment on lines 1 to 7
/**
* This file demonstrates how to find multiple documents by using the Java driver.
* It connects to a MongoDB deployment, accesses the "sample_mflix" database, and finds
* documents in the "movies" collection that match the specified query filter.
* The code projects certain fields in the returned documents and sorts them according to
* specified criteria.
*/
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
/**
* This file demonstrates how to find multiple documents by using the Java driver.
* It connects to a MongoDB deployment, accesses the "sample_mflix" database, and finds
* documents in the "movies" collection that match the specified query filter.
* The code projects certain fields in the returned documents and sorts them according to
* specified criteria.
*/
// Find multiple documents by using the MongoDB Java driver

Comment on lines 1 to 6
/**
* This file demonstrates how to find a document by using the Java driver.
* It connects to a MongoDB deployment, accesses the "sample_mflix" database, and finds
* a document in the "movies" collection that matches the specified query filter.
* The code projects certain fields in the returned document.
*/
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
/**
* This file demonstrates how to find a document by using the Java driver.
* It connects to a MongoDB deployment, accesses the "sample_mflix" database, and finds
* a document in the "movies" collection that matches the specified query filter.
* The code projects certain fields in the returned document.
*/
// Find a document by using the MongoDB Java driver

Comment on lines 1 to 6
/**
* This file demonstrates how to insert multiple documents into a collection by
* using the Java driver.
* The file connects to a MongoDB deployment, accesses the "sample_mflix" database,
* and inserts two new documents into the "movies" collection.
*/
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
/**
* This file demonstrates how to insert multiple documents into a collection by
* using the Java driver.
* The file connects to a MongoDB deployment, accesses the "sample_mflix" database,
* and inserts two new documents into the "movies" collection.
*/
// Insert multiple documents into a collection using the Java driver.

Comment on lines 1 to 6
/**
* This file demonstrates how to insert a document into a collection by using the
* Java driver.
* The file connects to a MongoDB deployment, accesses the "sample_mflix" database,
* and inserts a new document into the "movies" collection.
*/
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
/**
* This file demonstrates how to insert a document into a collection by using the
* Java driver.
* The file connects to a MongoDB deployment, accesses the "sample_mflix" database,
* and inserts a new document into the "movies" collection.
*/
// Insert a document into a collection using the MongoDB Java driver.

@norareidy norareidy merged commit 9399fbc into mongodb:master Oct 18, 2023
@norareidy norareidy deleted the DOCSP-33345-java-comments-2 branch October 18, 2023 20:26
norareidy added a commit that referenced this pull request Oct 18, 2023
* DOCSP-33345: Java code comments pt. 2

* CC edits

* CD feedback + sheet syntax

(cherry picked from commit 9399fbc)
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