DOCSP-33345: Java code comments pt. 1 #469
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
caitlindavey
approved these changes
Oct 11, 2023
| @@ -1,3 +1,9 @@ | |||
| /** | |||
| * This file demonstrates MongoDB bulk write operations by using the Java driver. | |||
There was a problem hiding this comment.
Personal opinion: There's something about the "This file" that feels clunky to me. I think maybe we delete that and change to:
Suggested change
| * This file demonstrates MongoDB bulk write operations by using the Java driver. | |
| * Conduct bulk write operations by using the Java driver. |
There was a problem hiding this comment.
And change comment to single line comment //
| @@ -1,3 +1,9 @@ | |||
| /** | |||
| * This file demonstrates MongoDB bulk write operations by using the Java driver. | |||
| * It connects to a MongoDB deployment, accesses the "sample_mflix" database, | |||
There was a problem hiding this comment.
I think delete the next two rows.
| @@ -1,3 +1,9 @@ | |||
| /** | |||
| * This file demonstrates how to run a command by using the Java driver. | |||
There was a problem hiding this comment.
Same note as above.
Suggested change
| * This file demonstrates how to run a command by using the Java driver. | |
| * // Run a command by using the MongoDB Java driver. |
| @@ -1,3 +1,10 @@ | |||
| /** | |||
| * This file demonstrates how to perform count operations by using the Java driver. | |||
There was a problem hiding this comment.
Suggested change
| * This file demonstrates how to perform count operations by using the Java driver. | |
| * // Perform count operations by using the MongoDB Java driver. |
| @@ -1,3 +1,10 @@ | |||
| /** | |||
| * This file demonstrates how to delete multiple documents in a collection by | |||
There was a problem hiding this comment.
Suggested change
| * This file demonstrates how to delete multiple documents in a collection by | |
| * // Delete multiple documents in a collection using the MongoDB Java driver. |
Comment on lines
2
to
6
| * This file demonstrates how to delete a document in a collection by using the | ||
| * Java driver. | ||
| * The file connects to a MongoDB deployment, accesses the "sample_mflix" database, | ||
| * and deletes a document in the "movies" collection based on a specified query. | ||
| */ |
There was a problem hiding this comment.
Suggested change
| * This file demonstrates how to delete a document in a collection by using the | |
| * Java driver. | |
| * The file connects to a MongoDB deployment, accesses the "sample_mflix" database, | |
| * and deletes a document in the "movies" collection based on a specified query. | |
| */ | |
| * // Delete a document in a collection by using the MongoDB Java driver. |
norareidy
added a commit
that referenced
this pull request
Oct 18, 2023
* DOCSP-33345: Java code comments pt. 1 * file summaries * indicative mood * CC edits * CD feedback + sheet syntax (cherry picked from commit d198b0f)
norareidy
added a commit
that referenced
this pull request
Oct 18, 2023
* DOCSP-33345: Java code comments pt. 1 * file summaries * indicative mood * CC edits * CD feedback + sheet syntax (cherry picked from commit d198b0f)
norareidy
added a commit
that referenced
this pull request
Oct 18, 2023
* DOCSP-33345: Java code comments pt. 1 * file summaries * indicative mood * CC edits * CD feedback + sheet syntax (cherry picked from commit d198b0f)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Pull Request Info
PR Reviewing Guidelines
JIRA - https://jira.mongodb.org/browse/DOCSP-33345
Staging:
Bulk write - https://preview-mongodbnorareidy.gatsbyjs.io/java/DOCSP-33345-java-comments-1/usage-examples/bulkWrite/
Run command - https://preview-mongodbnorareidy.gatsbyjs.io/java/DOCSP-33345-java-comments-1/usage-examples/command/
Count - https://preview-mongodbnorareidy.gatsbyjs.io/java/DOCSP-33345-java-comments-1/usage-examples/count/
DeleteOne - https://preview-mongodbnorareidy.gatsbyjs.io/java/DOCSP-33345-java-comments-1/usage-examples/deleteOne/
DeleteMany - https://preview-mongodbnorareidy.gatsbyjs.io/java/DOCSP-33345-java-comments-1/usage-examples/deleteMany/
Self-Review Checklist