DOCSP-46866: Cleanup #14
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-django ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
Jibola
reviewed
Jan 30, 2025
source/get-started/query-data.txt
Outdated
| @@ -17,7 +17,7 @@ to read data from the ``sample_mflix`` database. | |||
| .. procedure:: | |||
| :style: connected | |||
|
|
|||
| .. step:: Query the "users" collection for a specified email | |||
| .. step:: Query the users collection for a specified email | |||
There was a problem hiding this comment.
why the removal of quotes? Should this be Users instead?
There was a problem hiding this comment.
Usually we format collection names without quotes, monospaced (like here). But we also don't use monospace text in headers. However since this is a step, not a header, I'll change to users collection
Jibola
reviewed
Jan 30, 2025
source/get-started/query-data.txt
Outdated
| @@ -42,7 +42,7 @@ to read data from the ``sample_mflix`` database. | |||
|
|
|||
| <Viewer: Khal Drogo> | |||
|
|
|||
| .. step:: Query the "movies" collection for specified runtime values | |||
| .. step:: Query the movies collection for specified runtime values | |||
source/get-started/write-data.txt
Outdated
| @@ -39,7 +39,7 @@ and delete functions on your model objects. | |||
| :language: python | |||
| :copyable: | |||
|
|
|||
| .. step:: Insert a movie into the database | |||
| .. step:: Insert a Movie into the database | |||
There was a problem hiding this comment.
should this stay lowercase since it's not a proper noun?
There was a problem hiding this comment.
The Movie objects are capitalized; I'll add "object" after to make that clear
Jibola
approved these changes
Jan 30, 2025
Jibola
approved these changes
Jan 30, 2025
rachel-mack
approved these changes
Jan 30, 2025
source/get-started.txt
Outdated
| @@ -15,7 +15,7 @@ Get Started with {+django-odm+} | |||
| :values: tutorial | |||
|
|
|||
| .. meta:: | |||
| :description: Learn how to create an app to connect to a MongoDB deployment by using Django MongoDB Backend. | |||
| :description: Learn how to create an app to connect to a MongoDB deployment by using {+framework+} MongoDB Backend. | |||
There was a problem hiding this comment.
Should we be using variables in the meta descriptions?
There was a problem hiding this comment.
I thought they didn't render correctly but just checked and they do! So I'll update the descriptions
source/model-data/models.txt
Outdated
Comment on lines
379
to
382
| - ``options``: Specifies {+framework+} field options. This field is | ||
| optional. To view a list of available options, see `Field options | ||
| <{+django-docs+}/ref/models/fields/#field-options>`__ | ||
| in the {+framework+} documentation. |
There was a problem hiding this comment.
I would make this change in all the instances that use "This field is optional."
Suggested change
| - ``options``: Specifies {+framework+} field options. This field is | |
| optional. To view a list of available options, see `Field options | |
| <{+django-docs+}/ref/models/fields/#field-options>`__ | |
| in the {+framework+} documentation. | |
| - ``options`` (optional): Specifies {+framework+} field options. To view a list of available options, see `Field options | |
| <{+django-docs+}/ref/models/fields/#field-options>`__ | |
| in the {+framework+} documentation. |
source/model-data/models.txt
Outdated
Comment on lines
460
to
462
| `Model field reference <{+django-docs+}/ref/models/fields/>`__ | ||
| in the {+framework+} documentation. |
There was a problem hiding this comment.
Suggested change
| To learn more about {+framework+} field types, see | |
| `Model field reference <{+django-docs+}/ref/models/fields/>`__ | |
| in the {+framework+} documentation. | |
| To learn more about {+framework+} field types, see the | |
| `Model field reference <{+django-docs+}/ref/models/fields/>`__ | |
| in the {+framework+} documentation. |
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-46866
Staging Links
Self-Review Checklist