DOCSP-32078: data class note #132
Merged
Conversation
This file contains 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
# Pull Request Info [PR Reviewing Guidelines](https://github.com/mongodb/docs-java/blob/master/REVIEWING.md) JIRA - https://jira.mongodb.org/browse/DOCSP-31827 Staging - https://docs-mongodbcom-staging.corp.mongodb.com/kotlin/docsworker-xlarge/DOCSP-31827-update-titles/fundamentals/crud/write-operations/modify/ https://docs-mongodbcom-staging.corp.mongodb.com/kotlin/docsworker-xlarge/DOCSP-31827-update-titles/fundamentals/crud/write-operations/delete/ Redirects - Redirect 301 /docs/drivers/kotlin/coroutine/v4.10/fundamentals/crud/write-operations/change-a-document/ https://www.mongodb.com/docs/drivers/kotlin/coroutine/v4.10/fundamentals/crud/write-operations/modify/ Redirect 301 /docs/drivers/kotlin/coroutine/master/fundamentals/crud/write-operations/change-a-document/ https://www.mongodb.com/docs/drivers/kotlin/coroutine/master/fundamentals/crud/write-operations/modify/ ## 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?
* DOCSP-30911: Add server lifecycle support callout
* 092223: Remove rapid release version from compat table
…s-kotlin into DOCSP-32078-data-class-note
ccho-mongodb
approved these changes
Oct 2, 2023
Comment on lines
118
to
123
| .. note:: | ||
|
|
||
| Use this annotation only on a property you are | ||
| storing as a different BSON type. You might experience errors | ||
| if you include the ``BsonRepresentation`` annotation on a | ||
| property you are storing as the same type. |
There was a problem hiding this comment.
Suggestion:
I think the current description ("Specifies the BSON type...") could be modified to communicate what's in this callout which would make the content of this description less repetitive.
"Specifies the BSON type MongoDB uses to store the value. Use this annotation only when you need to store the value as a BSON type that differs from the data class property."
And perhaps the callout could be a warning if necessary:
"Your code may throw exceptions If you specify the same type as the data class."
|
✨ Staging URL: https://preview-mongodbmongodb.gatsbyjs.io/kotlin/master/ 🪵 Logs |
ccho-mongodb
pushed a commit
to ccho-mongodb/docs-kotlin
that referenced
this pull request
Oct 2, 2023
* add vale action * DOCSP-31827: Update page titles (mongodb#123) # Pull Request Info [PR Reviewing Guidelines](https://github.com/mongodb/docs-java/blob/master/REVIEWING.md) JIRA - https://jira.mongodb.org/browse/DOCSP-31827 Staging - https://docs-mongodbcom-staging.corp.mongodb.com/kotlin/docsworker-xlarge/DOCSP-31827-update-titles/fundamentals/crud/write-operations/modify/ https://docs-mongodbcom-staging.corp.mongodb.com/kotlin/docsworker-xlarge/DOCSP-31827-update-titles/fundamentals/crud/write-operations/delete/ Redirects - Redirect 301 /docs/drivers/kotlin/coroutine/v4.10/fundamentals/crud/write-operations/change-a-document/ https://www.mongodb.com/docs/drivers/kotlin/coroutine/v4.10/fundamentals/crud/write-operations/modify/ Redirect 301 /docs/drivers/kotlin/coroutine/master/fundamentals/crud/write-operations/change-a-document/ https://www.mongodb.com/docs/drivers/kotlin/coroutine/master/fundamentals/crud/write-operations/modify/ ## 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? * Fix Vale GH action (mongodb#125) * DOCSP-32483 programmatic tagging script for the kotlin driver repo (mongodb#126) * DOCSP-30911: Add server lifecycle support callout (mongodb#127) * DOCSP-30911: Add server lifecycle support callout * 092123 trivial change to test GH action that copies compat tables (mongodb#128) * 092123: Fix copy-compat-to-docs-shared action (mongodb#129) * 092223 compatibility copy (mongodb#130) * 092223: Remove rapid release version from compat table * DOCSP-32078: bsonrepresentation note * column width adjustment * vale fix --------- Co-authored-by: Nora Reidy <nora.reidy@mongodb.com> Co-authored-by: Chris Cho <chris.cho@mongodb.com> Co-authored-by: Sarah Lin <55722001+sarahemlin@users.noreply.github.com>
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-32078
Staging - https://preview-mongodbrustagir.gatsbyjs.io/kotlin/DOCSP-32078-data-class-note/fundamentals/data-formats/document-data-format-data-class/#specify-component-conversion-using-annotations
Self-Review Checklist