Add comment for all examples converted to verbose form

GromNaN · GromNaN · commit a02228cf85c7 · 2024-01-31T14:01:14.000+01:00
diff --git a/generator/config/accumulator/covariancePop.yaml b/generator/config/accumulator/covariancePop.yaml
@@ -30,6 +30,7 @@ tests:
                         covariancePopForState:
                             $covariancePop:
                                 -
+                                    # Example uses the short form, the builder always generates the verbose form
                                     # $year: '$orderDate'
                                     $year:
                                         date: '$orderDate'
diff --git a/generator/config/accumulator/covarianceSamp.yaml b/generator/config/accumulator/covarianceSamp.yaml
@@ -30,6 +30,7 @@ tests:
                         covarianceSampForState:
                             $covarianceSamp:
                                 -
+                                    # Example uses the short form, the builder always generates the verbose form
                                     # $year: '$orderDate'
                                     $year:
                                         date: '$orderDate'
diff --git a/generator/config/accumulator/push.yaml b/generator/config/accumulator/push.yaml
@@ -26,10 +26,12 @@ tests:
                 $group:
                     _id:
                         day:
+                            # Example uses the short form, the builder always generates the verbose form
                             # $dayOfYear: '$date'
                             $dayOfYear:
                                 date: '$date'
                         year:
+                            # Example uses the short form, the builder always generates the verbose form
                             # $year: '$date'
                             $year:
                                 date: '$date'
diff --git a/generator/config/accumulator/sum.yaml b/generator/config/accumulator/sum.yaml
@@ -22,10 +22,12 @@ tests:
                 $group:
                     _id:
                         day:
+                            # Example uses the short form, the builder always generates the verbose form
                             # $dayOfYear: '$date'
                             $dayOfYear:
                                 date: '$date'
                         year:
+                            # Example uses the short form, the builder always generates the verbose form
                             # $year: '$date'
                             $year:
                                 date: '$date'
diff --git a/generator/config/expression/arrayToObject.yaml b/generator/config/expression/arrayToObject.yaml
@@ -20,7 +20,7 @@ tests:
                 $project:
                     item: 1
                     dimensions:
-                        # The example renders a single value, but the builder generates an array for consistency
+                        # Example uses the short form, the builder always generates the verbose form
                         # $arrayToObject: '$dimensions'
                         $arrayToObject:
                             - '$dimensions'
diff --git a/generator/config/expression/avg.yaml b/generator/config/expression/avg.yaml
@@ -21,6 +21,7 @@ tests:
             -
                 $project:
                     quizAvg:
+                        # Example uses the short form, the builder always generates the verbose form
                         # $avg: '$quizzes'
                         $avg:
                             - '$quizzes'
diff --git a/generator/config/expression/dateAdd.yaml b/generator/config/expression/dateAdd.yaml
@@ -46,6 +46,7 @@ tests:
                             unit: 'day'
                             amount: 3
             -
+                # Example uses the short form, the builder always generates the verbose form
                 # $merge: 'shipping'
                 $merge:
                     into: 'shipping'
diff --git a/generator/config/expression/dateFromString.yaml b/generator/config/expression/dateFromString.yaml
@@ -76,6 +76,5 @@ tests:
                         $dateFromString:
                             dateString: '$date'
                             timezone: '$timezone'
-                            # onNull: new Date(0)
                             onNull: !bson_utcdatetime 0
 
diff --git a/generator/config/expression/dateSubtract.yaml b/generator/config/expression/dateSubtract.yaml
@@ -43,6 +43,7 @@ tests:
                     $expr:
                         $eq:
                             -
+                                # Example uses the short form, the builder always generates the verbose form
                                 # $month: '$logout'
                                 $month:
                                     date: '$logout'
@@ -55,6 +56,7 @@ tests:
                             unit: 'hour'
                             amount: 3
             -
+                # Example uses the short form, the builder always generates the verbose form
                 # $merge: 'connectionTime'
                 $merge:
                     into: 'connectionTime'
diff --git a/generator/config/expression/dayOfMonth.yaml b/generator/config/expression/dayOfMonth.yaml
@@ -30,6 +30,7 @@ tests:
             -
                 $project:
                     day:
+                        # Example uses the short form, the builder always generates the verbose form
                         # $dayOfMonth: '$date'
                         $dayOfMonth:
                             date: '$date'
diff --git a/generator/config/expression/dayOfWeek.yaml b/generator/config/expression/dayOfWeek.yaml
@@ -30,6 +30,7 @@ tests:
             -
                 $project:
                     dayOfWeek:
+                        # Example uses the short form, the builder always generates the verbose form
                         # $dayOfWeek: '$date'
                         $dayOfWeek:
                             date: '$date'
diff --git a/generator/config/expression/dayOfYear.yaml b/generator/config/expression/dayOfYear.yaml
@@ -30,6 +30,7 @@ tests:
             -
                 $project:
                     dayOfYear:
+                        # Example uses the short form, the builder always generates the verbose form
                         # $dayOfYear: '$date'
                         $dayOfYear:
                             date: '$date'
diff --git a/generator/config/expression/getField.yaml b/generator/config/expression/getField.yaml
@@ -33,7 +33,7 @@ tests:
                     $expr:
                         $gt:
                             -
-                                # the builder uses the verbose form with parameter names
+                                # Example uses the short form, the builder always generates the verbose form
                                 # $getField: 'price.usd'
                                 $getField:
                                     field: 'price.usd'
@@ -48,7 +48,7 @@ tests:
                         $gt:
                             -
                                 $getField:
-                                    # the builder uses the verbose form with parameter names
+                                    # Example uses the short form, the builder always generates the verbose form
                                     # $literal: '$price'
                                     field:
                                         $literal: '$price'
diff --git a/generator/config/expression/hour.yaml b/generator/config/expression/hour.yaml
@@ -30,6 +30,7 @@ tests:
             -
                 $project:
                     hour:
+                        # Example uses the short form, the builder always generates the verbose form
                         # $hour: '$date'
                         $hour:
                             date: '$date'
diff --git a/generator/config/expression/isArray.yaml b/generator/config/expression/isArray.yaml
@@ -22,8 +22,7 @@ tests:
                         $cond:
                             if:
                                 $and:
-                                    # The example in the docs uses the short syntax for $isArray,
-                                    # but the aggregation builder always uses the more verbose syntax.
+                                    # Example uses the short form, the builder always generates the verbose form
                                     -
                                         $isArray:
                                             - '$instock'
diff --git a/generator/config/expression/isoDayOfWeek.yaml b/generator/config/expression/isoDayOfWeek.yaml
@@ -32,6 +32,7 @@ tests:
                     _id: 0
                     name: '$name'
                     dayOfWeek:
+                        # Example uses the short form, the builder always generates the verbose form
                         # $isoDayOfWeek: '$birthday'
                         $isoDayOfWeek:
                             date: '$birthday'
diff --git a/generator/config/expression/isoWeek.yaml b/generator/config/expression/isoWeek.yaml
@@ -32,6 +32,7 @@ tests:
                     _id: 0
                     city: '$city'
                     weekNumber:
+                        # Example uses the short form, the builder always generates the verbose form
                         # $isoWeek: '$date'
                         $isoWeek:
                             date: '$date'
diff --git a/generator/config/expression/isoWeekYear.yaml b/generator/config/expression/isoWeekYear.yaml
@@ -30,6 +30,7 @@ tests:
             -
                 $project:
                     yearNumber:
+                        # Example uses the short form, the builder always generates the verbose form
                         # $isoWeekYear: '$date'
                         $isoWeekYear:
                             date: '$date'
diff --git a/generator/config/expression/map.yaml b/generator/config/expression/map.yaml
@@ -53,7 +53,7 @@ tests:
                             input: '$distances'
                             as: 'decimalValue'
                             in:
-                                # The example renders a single value, but the builder generates an array for consistency
+                                # Example uses the short form, the builder always generates the verbose form
                                 # $trunc: '$$decimalValue'
                                 $trunc:
                                     - '$$decimalValue'
diff --git a/generator/config/expression/max.yaml b/generator/config/expression/max.yaml
@@ -21,6 +21,7 @@ tests:
             -
                 $project:
                     quizMax:
+                        # Example uses the short form, the builder always generates the verbose form
                         # $max: '$quizzes'
                         $max:
                             - '$quizzes'
diff --git a/generator/config/expression/millisecond.yaml b/generator/config/expression/millisecond.yaml
@@ -30,6 +30,7 @@ tests:
             -
                 $project:
                     milliseconds:
+                        # Example uses the short form, the builder always generates the verbose form
                         # $millisecond: '$date'
                         $millisecond:
                             date: '$date'
diff --git a/generator/config/expression/min.yaml b/generator/config/expression/min.yaml
@@ -21,6 +21,7 @@ tests:
             -
                 $project:
                     quizMin:
+                        # Example uses the short form, the builder always generates the verbose form
                         # $min: '$quizzes'
                         $min:
                             - '$quizzes'
diff --git a/generator/config/expression/minute.yaml b/generator/config/expression/minute.yaml
@@ -30,6 +30,7 @@ tests:
             -
                 $project:
                     minutes:
+                        # Example uses the short form, the builder always generates the verbose form
                         # $minute: '$date'
                         $minute:
                             date: '$date'
diff --git a/generator/config/expression/month.yaml b/generator/config/expression/month.yaml
@@ -30,6 +30,7 @@ tests:
             -
                 $project:
                     month:
+                        # Example uses the short form, the builder always generates the verbose form
                         # $month: '$date'
                         $month:
                             date: '$date'
diff --git a/generator/config/expression/objectToArray.yaml b/generator/config/expression/objectToArray.yaml
@@ -33,7 +33,7 @@ tests:
                     warehouses:
                         $objectToArray: '$instock'
             -
-                # The builder uses the verbose form of the $unwind operator
+                # Example uses the short form, the builder always generates the verbose form
                 # $unwind: '$warehouses'
                 $unwind:
                     path: '$warehouses'
diff --git a/generator/config/expression/pow.yaml b/generator/config/expression/pow.yaml
@@ -25,7 +25,7 @@ tests:
                     variance:
                         $pow:
                             -
-                                # The builder renders $stdDevPop with the array form, even with a single value
+                                # Example uses the short form, the builder always generates the verbose form
                                 # $stdDevPop: '$scores.score'
                                 $stdDevPop: ['$scores.score']
                             - 2
diff --git a/generator/config/expression/rand.yaml b/generator/config/expression/rand.yaml
@@ -23,6 +23,7 @@ tests:
                     amount:
                         $floor: '$amount'
             -
+                # Example uses the short form, the builder always generates the verbose form
                 # $merge: 'donors'
                 $merge:
                     into: 'donors'
diff --git a/generator/config/expression/second.yaml b/generator/config/expression/second.yaml
@@ -30,6 +30,7 @@ tests:
             -
                 $project:
                     seconds:
+                        # Example uses the short form, the builder always generates the verbose form
                         # $second: '$date'
                         $second:
                             date: '$date'
diff --git a/generator/config/expression/setField.yaml b/generator/config/expression/setField.yaml
@@ -39,6 +39,7 @@ tests:
                         input: '$$ROOT'
                         value: '$price'
             -
+                # Example uses the short form, the builder always generates the verbose form
                 # $unset: 'price'
                 $unset:
                     - 'price'
@@ -54,6 +55,7 @@ tests:
                         input: '$$ROOT'
                         value: '$price'
             -
+                # Example uses the short form, the builder always generates the verbose form
                 # $unset: 'price'
                 $unset:
                     - 'price'
diff --git a/generator/config/expression/size.yaml b/generator/config/expression/size.yaml
@@ -24,8 +24,7 @@ tests:
                     numberOfColors:
                         $cond:
                             if:
-                                # The example in the docs uses the short syntax for $isArray,
-                                # but the aggregation builder always uses the more verbose syntax.
+                                # Example uses the short form, the builder always generates the verbose form
                                 # $isArray: '$colors'
                                 $isArray:
                                     - '$colors'
diff --git a/generator/config/expression/sortArray.yaml b/generator/config/expression/sortArray.yaml
@@ -101,8 +101,7 @@ tests:
                                     a:
                                         sale: true
                                         price: 19
-                                # Decimal128( "10.23" )
-                                - 10.23
+                                - !bson_decimal128 '10.23'
                                 -
                                     a: 'On sale'
                             sortBy: 1
diff --git a/generator/config/expression/stdDevPop.yaml b/generator/config/expression/stdDevPop.yaml
@@ -22,5 +22,6 @@ tests:
             -
                 $project:
                     stdDev:
+                        # Example uses the short form, the builder always generates the verbose form
                         # $stdDevPop: '$scores.score'
                         $stdDevPop: ['$scores.score']
diff --git a/generator/config/expression/sum.yaml b/generator/config/expression/sum.yaml
@@ -22,6 +22,7 @@ tests:
             -
                 $project:
                     quizTotal:
+                        # Example uses the short form, the builder always generates the verbose form
                         # $sum: '$quizzes'
                         $sum:
                             - '$quizzes'
diff --git a/generator/config/expression/unsetField.yaml b/generator/config/expression/unsetField.yaml
@@ -53,6 +53,7 @@ tests:
                             $unsetField:
                                 field: 'euro'
                                 input:
+                                    # Example uses the short form, the builder always generates the verbose form
                                     # $getField: 'price'
                                     $getField:
                                         field: 'price'
diff --git a/generator/config/expression/week.yaml b/generator/config/expression/week.yaml
@@ -30,6 +30,7 @@ tests:
             -
                 $project:
                     week:
+                        # Example uses the short form, the builder always generates the verbose form
                         # $week: '$date'
                         $week:
                             date: '$date'
diff --git a/generator/config/expression/year.yaml b/generator/config/expression/year.yaml
@@ -30,6 +30,7 @@ tests:
             -
                 $project:
                     year:
+                        # Example uses the short form, the builder always generates the verbose form
                         # $year: '$date'
                         $year:
                             date: '$date'
diff --git a/generator/config/query/type.yaml b/generator/config/query/type.yaml
@@ -21,31 +21,31 @@ tests:
             -
                 $match:
                     zipCode:
-                        # Example uses the short form, the builder always generated the verbose form
+                        # Example uses the short form, the builder always generates the verbose form
                         # $type: 2
                         $type: [2]
             -
                 $match:
                     zipCode:
-                        # Example uses the short form, the builder always generated the verbose form
+                        # Example uses the short form, the builder always generates the verbose form
                         # $type: 'string'
                         $type: ['string']
             -
                 $match:
                     zipCode:
-                        # Example uses the short form, the builder always generated the verbose form
+                        # Example uses the short form, the builder always generates the verbose form
                         # $type: 1
                         $type: [1]
             -
                 $match:
                     zipCode:
-                        # Example uses the short form, the builder always generated the verbose form
+                        # Example uses the short form, the builder always generates the verbose form
                         # $type: 'double'
                         $type: ['double']
             -
                 $match:
                     zipCode:
-                        # Example uses the short form, the builder always generated the verbose form
+                        # Example uses the short form, the builder always generates the verbose form
                         # $type: 'number'
                         $type: ['number']
     -
@@ -67,13 +67,13 @@ tests:
             -
                 $match:
                     zipCode:
-                        # Example uses the short form, the builder always generated the verbose form
+                        # Example uses the short form, the builder always generates the verbose form
                         # $type: 'minKey'
                         $type: ['minKey']
             -
                 $match:
                     zipCode:
-                        # Example uses the short form, the builder always generated the verbose form
+                        # Example uses the short form, the builder always generates the verbose form
                         # $type: 'maxKey'
                         $type: ['maxKey']
     -
@@ -83,6 +83,6 @@ tests:
             -
                 $match:
                     zipCode:
-                        # Example uses the short form, the builder always generated the verbose form
+                        # Example uses the short form, the builder always generates the verbose form
                         # $type: 'array'
                         $type: ['array']
diff --git a/generator/config/stage/unionWith.yaml b/generator/config/stage/unionWith.yaml
diff --git a/generator/config/stage/unset.yaml b/generator/config/stage/unset.yaml
diff --git a/generator/config/stage/unwind.yaml b/generator/config/stage/unwind.yaml
diff --git a/tests/Builder/Expression/Pipelines.php b/tests/Builder/Expression/Pipelines.php
diff --git a/tests/Builder/Expression/SortArrayOperatorTest.php b/tests/Builder/Expression/SortArrayOperatorTest.php

Original file line number	Diff line number	Diff line change
`@@ -30,6 +30,7 @@ tests:`
`30`	`30`	`covariancePopForState:`
`31`	`31`	`$covariancePop:`
`32`	`32`	`-`
	`33`	`+ # Example uses the short form, the builder always generates the verbose form`
`33`	`34`	`# $year: '$orderDate'`
`34`	`35`	`$year:`
`35`	`36`	`date: '$orderDate'`
Original file line number	Diff line number	Diff line change
`@@ -21,6 +21,7 @@ tests:`
`21`	`21`	`-`
`22`	`22`	`$project:`
`23`	`23`	`quizAvg:`
	`24`	`+ # Example uses the short form, the builder always generates the verbose form`
`24`	`25`	`# $avg: '$quizzes'`
`25`	`26`	`$avg:`
`26`	`27`	`- '$quizzes'`
Original file line number	Diff line number	Diff line change
`@@ -46,6 +46,7 @@ tests:`
`46`	`46`	`unit: 'day'`
`47`	`47`	`amount: 3`
`48`	`48`	`-`
	`49`	`+ # Example uses the short form, the builder always generates the verbose form`
`49`	`50`	`# $merge: 'shipping'`
`50`	`51`	`$merge:`
`51`	`52`	`into: 'shipping'`