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.

Sign up for GitHub

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-32078: data class note #132

Merged
merged 14 commits into from
Oct 2, 2023
Merged

DOCSP-32078: data class note #132

Changes from 13 commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
131eaca
add vale action
rustagir Sep 5, 2023
a2ba9ee
DOCSP-31827: Update page titles (#123)
norareidy Sep 5, 2023
880ddae
Fix Vale GH action (#125)
Sep 5, 2023
46b4b5a
DOCSP-32483 programmatic tagging script for the kotlin driver repo (#…
sarahemlin Sep 7, 2023
28fe925
DOCSP-30911: Add server lifecycle support callout (#127)
Sep 21, 2023
67a0a7d
092123 trivial change to test GH action that copies compat tables (#128)
Sep 21, 2023
286f1bb
092123: Fix copy-compat-to-docs-shared action (#129)
Sep 22, 2023
9a2416b
092223 compatibility copy (#130)
Sep 22, 2023
b745cc3
DOCSP-32078: bsonrepresentation note
rustagir Oct 2, 2023
aa9bed1
column width adjustment
rustagir Oct 2, 2023
6df6dda
Merge branch 'master' into DOCSP-32078-data-class-note
rustagir Oct 2, 2023
89449f2
vale fix
rustagir Oct 2, 2023
03c01a4
Merge branch 'DOCSP-32078-data-class-note' of github.com:rustagir/doc…
rustagir Oct 2, 2023
12f1745
CC suggestion
rustagir Oct 2, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 8 additions & 1 deletion source/fundamentals/data-formats/document-data-format-data-class.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ You can use the following annotations on data classes:
.. list-table::
:header-rows: 1
:stub-columns: 1
:widths: 10 10
:widths: 30 70

* - Annotation Name
- Description
Expand All @@ -114,6 +114,13 @@ You can use the following annotations on data classes:
* - ``BsonRepresentation``
- Specifies the BSON type used to store the value when different from the
data class property.

.. 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.
Copy link
Contributor

Choose a reason for hiding this comment

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

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."


For reference information on these property annotations,
refer to the `org.bson.codecs.pojo.annotations <{+api+}/apidocs/bson/org/bson/codecs/pojo/annotations/package-summary.html>`__
Expand Down
Loading