DOCSP-41146: agg exp operations #32
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
👷 Deploy request for docs-kotlin-sync pending review.Visit the deploys page to approve it
|
mcmorisi
requested changes
Aug 7, 2024
source/aggregation/agg-exp-ops.txt
Outdated
| - ``group(<expression>)`` | ||
|
|
||
| .. TODO To learn more about these methods, see the | ||
| .. :ref:`kotlin-sync-sync-aggregation`. |
There was a problem hiding this comment.
Suggested change
| .. :ref:`kotlin-sync-sync-aggregation`. | |
| .. :ref:`kotlin-sync-aggregation`. |
source/aggregation/agg-exp-ops.txt
Outdated
Comment on lines
398
to
399
| ``getArray()`` method if you work with the values of the | ||
| array as their specific type. |
There was a problem hiding this comment.
Q: Little unclear on the meaning of the "if you work with the values of the array as their specific type". Is there any way to reword this?
source/aggregation/agg-exp-ops.txt
Outdated
| readings (in degrees Fahrenheit) as extreme. | ||
|
|
||
| The ``or()`` operator checks to see if temperatures are extreme by comparing | ||
| the ``temperature`` field to predefined values with ``lt()`` and ``gt()``. |
There was a problem hiding this comment.
Suggested change
| the ``temperature`` field to predefined values with ``lt()`` and ``gt()``. | |
| the ``temperature`` field to predefined values by using ``lt()`` and ``gt()``. |
source/aggregation/agg-exp-ops.txt
Outdated
Comment on lines
417
to
419
| the ``totalSeats`` and ``isAvailable`` variables. If you don't pull | ||
| out these intermediary values into variables, the code still produces | ||
| equivalent results. |
There was a problem hiding this comment.
Suggested change
| the ``totalSeats`` and ``isAvailable`` variables. If you don't pull | |
| out these intermediary values into variables, the code still produces | |
| equivalent results. | |
| the ``totalSeats`` and ``isAvailable`` variables. If you don't assign | |
| these intermediary values to variables, the code still produces | |
| equivalent results. |
source/aggregation/agg-exp-ops.txt
Outdated
Comment on lines
678
to
684
| One advantage of using the ``passTo()`` method is that you can reuse | ||
| your custom methods for other aggregations. You could | ||
| use the ``gradeAverage()`` method to find the average of grades for | ||
| groups of students filtered by entry year or district, not just their | ||
| class, for example. You could use the ``evaluate()`` method to evaluate, for | ||
| example, an individual student's performance, or an entire school's or | ||
| district's performance. |
There was a problem hiding this comment.
Suggestion to resolve some duplicative wording
Suggested change
| One advantage of using the ``passTo()`` method is that you can reuse | |
| your custom methods for other aggregations. You could | |
| use the ``gradeAverage()`` method to find the average of grades for | |
| groups of students filtered by entry year or district, not just their | |
| class, for example. You could use the ``evaluate()`` method to evaluate, for | |
| example, an individual student's performance, or an entire school's or | |
| district's performance. | |
| One advantage of using the ``passTo()`` method is that you can reuse | |
| your custom methods for other aggregations. For example, you could | |
| use the ``gradeAverage()`` method to find the average of grades for | |
| groups of students filtered by entry year or district, not just their | |
| class. Likewise, you could use the ``evaluate()`` method to evaluate | |
| an individual student's performance or an entire school's performance. |
source/aggregation/agg-exp-ops.txt
Outdated
Comment on lines
835
to
838
| The ``dayOfWeek()`` method determines which day of the week it is and converts | ||
| it to a number based on which day is a Monday according to the | ||
| ``"America/New_York"`` parameter. The ``eq()`` method compares this value to | ||
| ``2``, which corresponds to Monday based on the provided timezone parameter. |
There was a problem hiding this comment.
This is a little implementation-specific – I think this would serve readers better if it focused on the outcome of using the method.
mcmorisi
approved these changes
Aug 9, 2024
source/aggregation/agg-exp-ops.txt
Outdated
Comment on lines
190
to
202
| the Server manual documentation. While each method is effectively | ||
| equivalent to the corresponding Query API expression, they may differ in | ||
| expected parameters and implementation. | ||
|
|
||
| The example in each section uses the ``listOf()`` method to create a | ||
| pipeline from the aggregation stage. Then, each example passes the | ||
| pipeline to the ``aggregate()`` method of ``MongoCollection``. | ||
|
|
||
| .. note:: | ||
|
|
||
| The driver generates a Query API expression that may be different | ||
| from the Query API expression provided in each example. However, | ||
| both expressions will produce the same aggregation result. |
There was a problem hiding this comment.
Question: Is the last sentence in the first highlighted paragraph redundant with the highlighted note?
There was a problem hiding this comment.
I dont think so, I think paragraph sentence is talking about individual operators, while the note is talking about the completed expression, there is a typo though that i will fix (expression -> operator in the paragraph)
source/aggregation/agg-exp-ops.txt
Outdated
| average precipitation, in millimeters, for each month. | ||
|
|
||
| The ``multiply()`` operator multiplies the ``precipitation`` field by | ||
| ``25.4`` to convert the value to millimeters. The ``avg()`` accumulator method |
There was a problem hiding this comment.
Suggested change
| ``25.4`` to convert the value to millimeters. The ``avg()`` accumulator method | |
| ``25.4`` to convert the field value to millimeters. The ``avg()`` accumulator method |
source/aggregation/agg-exp-ops.txt
Outdated
Comment on lines
419
to
421
| the ``totalSeats`` and ``isAvailable`` variables. If you don't assign | ||
| these intermediary values to variables, the code still produces | ||
| equivalent results. |
There was a problem hiding this comment.
This is rendering oddly on the staging site
source/aggregation/agg-exp-ops.txt
Outdated
Comment on lines
959
to
962
| .. tip:: | ||
|
|
||
| Represent data as a map if the data maps | ||
| arbitrary keys such as dates or item IDs to values. |
There was a problem hiding this comment.
Thinking about the purpose of this page, is this tip necessary? This seems more relevant for a page about how to structure a data schema, as opposed to performing aggregation operations. We also have a pretty thorough example usecase later on in the section.
…SP-41146-agg-exp-operations
rozza
approved these changes
Aug 14, 2024
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-41146
Staging - https://preview-mongodbrustagir.gatsbyjs.io/kotlin-sync/DOCSP-41146-agg-exp-operations/agg-exp-ops/
Self-Review Checklist
Is this free of any warnings or errors in the RST?
WARNING(aggregation/agg-exp-ops.txt:0ish): Page not included in any toctree and not marked :orphan:Will be fixed by DOCSP-41145: Aggregation landing page #30
Did you run a spell-check?
Did you run a grammar-check?
Are all the links working?
Are the facets and meta keywords accurate?