DOCSP-22844: POJO CRUD examples #512
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
norareidy
requested changes
Jan 24, 2024
Comment on lines
72
to
75
| - ``PojoCodecProvider``, a codec provider that includes | ||
| :ref:`Codecs <fundamentals-codecs>` that define how to | ||
| encode and decode the data between the POJO format and BSON. The | ||
| provider also specifies which POJO classes or packages that the codecs |
There was a problem hiding this comment.
Q: is Codec uppercase or lowercase? Both are used in this description
There was a problem hiding this comment.
changed all non-monospace to lowercase
| provider also specifies which POJO classes or packages that the codecs | ||
| apply to. | ||
| - ``CodecRegistry`` instance that contains the codecs and other related information. | ||
| - ``MongoDatabase`` or ``MongoCollection`` instance configured to use the |
There was a problem hiding this comment.
S: to match the wording in the bullet below
Suggested change
| - ``MongoDatabase`` or ``MongoCollection`` instance configured to use the | |
| - ``MongoDatabase`` or ``MongoCollection`` instance that is configured to use the |
Comment on lines
83
to
84
| The following steps perform each of the configuration requirements to | ||
| use the sample POJO defined in the preceding section: |
There was a problem hiding this comment.
S: the wording here kinda implies that the step itself is the subject taking some action; you could reword so that the reader is the subject and the one taking action
Suggested change
| The following steps perform each of the configuration requirements to | |
| use the sample POJO defined in the preceding section: | |
| Perform the following steps to meet the configuration requirements defined in the preceding section: |
Comment on lines
128
to
129
| Codecs in the ``CodecRegistry``. You can configure either a database | ||
| or collection to specify the Codecs. |
There was a problem hiding this comment.
Q: same codec capitalization question as above
|
|
||
| - Instantiate a ``PojoCodecProvider`` which contains codecs which define how to | ||
| - Instantiate a ``PojoCodecProvider`` which contains codecs that define how to | ||
| encode/decode data between BSON and the POJO fields. |
There was a problem hiding this comment.
S: to remove the slash
Suggested change
| encode/decode data between BSON and the POJO fields. | |
| encode and decode data between BSON and the POJO fields. |
Comment on lines
72
to
73
| - ``PojoCodecProvider``, a codec provider that includes | ||
| :ref:`Codecs <fundamentals-codecs>` that define how to |
There was a problem hiding this comment.
S: a little repetitive
Suggested change
| - ``PojoCodecProvider``, a codec provider that includes | |
| :ref:`Codecs <fundamentals-codecs>` that define how to | |
| - ``PojoCodecProvider``, which provides | |
| :ref:`Codecs <fundamentals-codecs>` that define how to |
norareidy
approved these changes
Jan 25, 2024
| @@ -238,12 +209,13 @@ see the following API documentation: | |||
| Summary | |||
| ------- | |||
|
|
|||
| In this guide, we explained how to convert data between BSON and POJO fields | |||
| by performing the following: | |||
| In this guide, we explain how to convert data between BSON and POJO fields | |||
There was a problem hiding this comment.
S: since the style guide suggests limiting "we", you could reword to something like:
Suggested change
| In this guide, we explain how to convert data between BSON and POJO fields | |
| This guide describes how to convert data between BSON and POJO fields |
rustagir
added a commit
that referenced
this pull request
Jan 25, 2024
* DOCSP-22844: expand pojo example+revisions * full first draft * small fixes * add taxonomy * vale fix * NR PR fixes 1 * NR suggestion (cherry picked from commit 992dda6)
rustagir
added a commit
that referenced
this pull request
Jan 25, 2024
* DOCSP-22844: expand pojo example+revisions * full first draft * small fixes * add taxonomy * vale fix * NR PR fixes 1 * NR suggestion (cherry picked from commit 992dda6)
rustagir
added a commit
that referenced
this pull request
Jan 25, 2024
* DOCSP-22844: expand pojo example+revisions * full first draft * small fixes * add taxonomy * vale fix * NR PR fixes 1 * NR suggestion (cherry picked from commit 992dda6)
rustagir
added a commit
that referenced
this pull request
Jan 25, 2024
* DOCSP-22844: expand pojo example+revisions * full first draft * small fixes * add taxonomy * vale fix * NR PR fixes 1 * NR suggestion (cherry picked from commit 992dda6)
rustagir
added a commit
that referenced
this pull request
Jan 25, 2024
* DOCSP-22844: expand pojo example+revisions * full first draft * small fixes * add taxonomy * vale fix * NR PR fixes 1 * NR suggestion (cherry picked from commit 992dda6)
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-22844
Staging - https://preview-mongodbrustagir.gatsbyjs.io/java/DOCSP-33844-pojo-examples/fundamentals/data-formats/document-data-format-pojo/
Self-Review Checklist