DOCSP-42961: Removed Nested Components #581
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
✅ Deploy Preview for docs-java ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
lindseymoore
requested changes
Oct 18, 2024
| MongoClientSettings.builder() | ||
| .applyConnectionString(new ConnectionString("mongodb+srv://host1.acme.com"))) | ||
| - | Sets the host name to use to look up an SRV DNS record to find the | ||
| MongoDB hosts. When setting ``srvHost``, the driver does not process any associated |
There was a problem hiding this comment.
Suggested change
| MongoDB hosts. When setting ``srvHost``, the driver does not process any associated | |
| MongoDB hosts. | |
| When setting ``srvHost``, the driver does not process any associated |
Suggestion: Separate the method definition from the implementation details. Think it looks a bit crowded as is and seems to match the format of the next table entry.
| .. seealso:: | ||
|
|
||
| :ref:`bsonrepresentation-annotation-code-example` | ||
| POJO property. :ref:`bsonrepresentation-annotation-code-example` |
There was a problem hiding this comment.
Suggested change
| POJO property. :ref:`bsonrepresentation-annotation-code-example` | |
| POJO property. | |
| For more information on properly using the annotation, see the below :ref:`bsonrepresentation-annotation-code-example` on this page. |
Suggestion: Think it would be good to keep consistent with the sentence formatting and add an intro to the example. Also nice to indicate that the example is below on the same page.
Style guide on Table Text formatting: https://www.mongodb.com/docs/meta/style-guide/style/tables/#std-label-tables-text
Comment on lines
300
to
302
| nested within the field. When applying ``@BsonProperty`` to a private field, | ||
| **you must also add getter and setter methods for that field to serialize and | ||
| customize the field name**. |
There was a problem hiding this comment.
Suggested change
| nested within the field. When applying ``@BsonProperty`` to a private field, | |
| **you must also add getter and setter methods for that field to serialize and | |
| customize the field name**. | |
| nested within the field. | |
| When applying ``@BsonProperty`` to a private field, | |
| **you must also add getter and setter methods for that field to serialize and | |
| customize the field name**. |
Suggestion: Separate implementation detail from rest of definition for ease of reading.
| :ref:`BsonExtraElements Annotation Example <bsonextraelements-annotation-code-example>` | ||
| - ``Map<String, Object>`` | ||
|
|
||
| :ref:`BsonExtraElements Annotation Example <bsonextraelements-annotation-code-example>` |
There was a problem hiding this comment.
Suggested change
| :ref:`BsonExtraElements Annotation Example <bsonextraelements-annotation-code-example>` | |
| For more information on using the annotation, see the below :ref:`BsonExtraElements Annotation Example <bsonextraelements-annotation-code-example>` on this page. |
Suggestion: Same as above, think it would be nice to introduce ex. in a sentence.
lindseymoore
approved these changes
Oct 22, 2024
| .. seealso:: | ||
|
|
||
| :ref:`bsonrepresentation-annotation-code-example` | ||
| POJO property. See an example of :ref:`bsonrepresentation-annotation-code-example` on this page. |
There was a problem hiding this comment.
Suggested change
| POJO property. See an example of :ref:`bsonrepresentation-annotation-code-example` on this page. | |
| POJO property. See an example of a :ref:`bsonrepresentation-annotation-code-example` on this page. |
S: Flows a bit better grammatically with the "a"
Comment on lines
+302
to
+304
| | When applying ``@BsonProperty`` to a private field, | ||
| **you must also add getter and setter methods for that field to serialize and | ||
| customize the field name**. |
There was a problem hiding this comment.
Suggested change
| | When applying ``@BsonProperty`` to a private field, | |
| **you must also add getter and setter methods for that field to serialize and | |
| customize the field name**. | |
| | When applying ``@BsonProperty`` to a private field, | |
| **you must also add getter and setter methods for that field to serialize and | |
| customize the field name**. |
S: The bolding looks a little too bold for this small section. The Style Guide suggested using the gold Important directive to replace the Important note directive: https://www.mongodb.com/docs/meta/style-guide/nested-components/#important-or-warning.
There was a problem hiding this comment.
These are being removed as part of this nested component work where we want annotations taken out of tables.
There was a problem hiding this comment.
Is using the gold Important directive rather than the bolding not necessary here? Meant this gold directive that the style guide recommends: https://www.mongodb.com/docs/meta/style-guide/nested-components/#important-or-warning:~:text=IMPORTANT%3A%20Data%20transfer%20as%20part%20of%20the%20backup%20and%20restore%20process%20is%20charged%20separately.
Comment on lines
310
to
314
| types: | ||
| - `Document <{+api+}/apidocs/bson/org/bson/Document.html>`__ | ||
| - `BsonDocument <{+api+}/apidocs/bson/org/bson/BsonDocument.html>`__ | ||
| - ``Map<String, Object>`` | ||
| | |
There was a problem hiding this comment.
Suggested change
| types: | |
| - `Document <{+api+}/apidocs/bson/org/bson/Document.html>`__ | |
| - `BsonDocument <{+api+}/apidocs/bson/org/bson/BsonDocument.html>`__ | |
| - ``Map<String, Object>`` | |
| | | |
| types: | |
| - `Document <{+api+}/apidocs/bson/org/bson/Document.html>`__ | |
| - `BsonDocument <{+api+}/apidocs/bson/org/bson/BsonDocument.html>`__ | |
| - ``Map<String, Object>`` | |
| | |
The spacing is a bit off for this list in staging: https://deploy-preview-581--docs-java.netlify.app/fundamentals/data-formats/pojo-customization/#bsonrepresentation-error-example.
These spaces might fix.
caitlindavey
added a commit
that referenced
this pull request
Oct 23, 2024
* DOCSP-42961: Removed Nested Components * Fixing indentation errors * Fixing indentation errors again * Fixing indentation errors again * Fixing indentation errors again * Fixing indentation errors again+ * Fixing indentation errors again+ * Fixing code block indentation * tweaks based on internal review feedback * tweaks based on internal review feedback - indentation issues * tweaks based on internal review feedback - indentation issues * tweaks based on internal review feedback - indentation issues * tweaks based on internal review feedback - indentation issues * tweaks to bullet issue * tweaks to bullet issue (cherry picked from commit 1ec4a2c)
caitlindavey
added a commit
that referenced
this pull request
Oct 23, 2024
* DOCSP-42961: Removed Nested Components * Fixing indentation errors * Fixing indentation errors again * Fixing indentation errors again * Fixing indentation errors again * Fixing indentation errors again+ * Fixing indentation errors again+ * Fixing code block indentation * tweaks based on internal review feedback * tweaks based on internal review feedback - indentation issues * tweaks based on internal review feedback - indentation issues * tweaks based on internal review feedback - indentation issues * tweaks based on internal review feedback - indentation issues * tweaks to bullet issue * tweaks to bullet issue (cherry picked from commit 1ec4a2c)
caitlindavey
added a commit
that referenced
this pull request
Oct 23, 2024
* DOCSP-42961: Removed Nested Components * Fixing indentation errors * Fixing indentation errors again * Fixing indentation errors again * Fixing indentation errors again * Fixing indentation errors again+ * Fixing indentation errors again+ * Fixing code block indentation * tweaks based on internal review feedback * tweaks based on internal review feedback - indentation issues * tweaks based on internal review feedback - indentation issues * tweaks based on internal review feedback - indentation issues * tweaks based on internal review feedback - indentation issues * tweaks to bullet issue * tweaks to bullet issue (cherry picked from commit 1ec4a2c)
caitlindavey
added a commit
that referenced
this pull request
Oct 23, 2024
* DOCSP-42961: Removed Nested Components * Fixing indentation errors * Fixing indentation errors again * Fixing indentation errors again * Fixing indentation errors again * Fixing indentation errors again+ * Fixing indentation errors again+ * Fixing code block indentation * tweaks based on internal review feedback * tweaks based on internal review feedback - indentation issues * tweaks based on internal review feedback - indentation issues * tweaks based on internal review feedback - indentation issues * tweaks based on internal review feedback - indentation issues * tweaks to bullet issue * tweaks to bullet issue (cherry picked from commit 1ec4a2c)
caitlindavey
added a commit
that referenced
this pull request
Oct 23, 2024
* DOCSP-42961: Removed Nested Components * Fixing indentation errors * Fixing indentation errors again * Fixing indentation errors again * Fixing indentation errors again * Fixing indentation errors again+ * Fixing indentation errors again+ * Fixing code block indentation * tweaks based on internal review feedback * tweaks based on internal review feedback - indentation issues * tweaks based on internal review feedback - indentation issues * tweaks based on internal review feedback - indentation issues * tweaks based on internal review feedback - indentation issues * tweaks to bullet issue * tweaks to bullet issue (cherry picked from commit 1ec4a2c)
|
✨ Staging URL: http://mongodb.com/docs/drivers/java/sync/upcoming 🪵 Logs
|
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-42961
Staging - https://deploy-preview-581--docs-java.netlify.app/
Self-Review Checklist