DOCSP-30063: specify return type using withDocument #91
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
rustagir
force-pushed
the
DOCSP-30063-withDocument-method
branch
from
9cc4a44 to
ead074e
Compare
cbullinger
approved these changes
Jun 15, 2023
Collaborator
cbullinger
left a comment
cbullinger
left a comment
There was a problem hiding this comment.
This looks great! Nice job!
| With the MongoDB Kotlin driver, data can be modeled using Kotlin data classes or you can use a | ||
| `Document <{+api+}/apidocs/bson/org/bson/Document.html>`__ class | ||
| to store and retrieve data from MongoDB. | ||
| With the MongoDB Kotlin driver, You can model data by using Kotlin data |
Collaborator
There was a problem hiding this comment.
Suggested change
| With the MongoDB Kotlin driver, You can model data by using Kotlin data | |
| With the MongoDB Kotlin driver, you can model data by using Kotlin data |
| such as ``findOneAndUpdate()`` or ``findOneAndReplace()``. | ||
|
|
||
| The following example shows how you can retrieve a collection that | ||
| contains represented by the ``Fruit`` data class but return the result |
Collaborator
There was a problem hiding this comment.
missing a word? data? documents?
Suggested change
| contains represented by the ``Fruit`` data class but return the result | |
| contains data represented by the ``Fruit`` data class but return the result |
| import org.junit.jupiter.api.Test | ||
| import org.junit.jupiter.api.TestInstance | ||
| import java.util.concurrent.TimeUnit | ||
| import kotlin.test.Ignore |
Collaborator
There was a problem hiding this comment.
is this actually being used?
Contributor
Author
There was a problem hiding this comment.
WIll remove any unused imports from both code files relating to this PR
| The following example shows how you can retrieve a collection that | ||
| contains represented by the ``Fruit`` data class but return the result | ||
| of a ``findOneAndUpdate()`` operation as an instance of the ``NewFruit`` | ||
| class: |
Collaborator
There was a problem hiding this comment.
suggestion: mention the renamed field? it honestly took me a second to realize the difference between Fruit and NewFruit
Contributor
Author
There was a problem hiding this comment.
added descriptions of the operation to both pages.
Contributor
Author
|
I moved the subsection on the DB/collection page from the create coll section to the access a coll section, as the method applies when you are accessing a collection, not when you are creating one. |
rustagir
added a commit
that referenced
this pull request
Jun 20, 2023
# Pull Request Info [PR Reviewing Guidelines](https://github.com/mongodb/docs-java/blob/master/REVIEWING.md) JIRA - https://jira.mongodb.org/browse/DOCSP-30063 Staging: - [Specify return type in DB/coll page](https://docs-mongodbcom-staging.corp.mongodb.com/kotlin/docsworker-xlarge/DOCSP-30063-withDocument-method/fundamentals/databases-collections/#specify-return-type) - [new content in data class doc format pg](https://docs-mongodbcom-staging.corp.mongodb.com/kotlin/docsworker-xlarge/DOCSP-30063-withDocument-method/fundamentals/data-formats/document-data-format-data-class/#retrieve-a-data-class) ## Self-Review Checklist - [x] Is this free of any warnings or errors in the RST? - [ ] Did you run a spell-check? - [ ] Did you run a grammar-check? - [x] Are all the links working? (cherry picked from commit 8ebf256)
cbullinger
pushed a commit
that referenced
this pull request
Jun 23, 2023
[PR Reviewing Guidelines](https://github.com/mongodb/docs-java/blob/master/REVIEWING.md) JIRA - https://jira.mongodb.org/browse/DOCSP-30063 Staging: - [Specify return type in DB/coll page](https://docs-mongodbcom-staging.corp.mongodb.com/kotlin/docsworker-xlarge/DOCSP-30063-withDocument-method/fundamentals/databases-collections/#specify-return-type) - [new content in data class doc format pg](https://docs-mongodbcom-staging.corp.mongodb.com/kotlin/docsworker-xlarge/DOCSP-30063-withDocument-method/fundamentals/data-formats/document-data-format-data-class/#retrieve-a-data-class) - [x] Is this free of any warnings or errors in the RST? - [ ] Did you run a spell-check? - [ ] Did you run a grammar-check? - [x] Are all the links working? (cherry picked from commit 8ebf256)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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-30063
Staging:
Self-Review Checklist