DOCSP-24657 index of array example issue (#1705) (#1709)

* DOCSP-indexOfArray-example-issue

* DOCSP-indexOfArray-example-issue

* DOCSP-24657-indexOfArray-example-issue

Co-authored-by: jason-price-mongodb <[email protected]>

Co-authored-by: jason-price-mongodb <[email protected]>

Author: jason-price-mongodb

source/reference/operator/aggregation/indexOfArray.txt

@@ -28,21 +28,16 @@ Definition
 
       { $indexOfArray: [ <array expression>, <search expression>, <start>, <end> ] }
 
-
    .. list-table::
       :header-rows: 1
       :widths: 20 20 80
 
       * - Field
-   
         - Type
-   
         - Description
 
-      * - ``<array>``
-   
+      * - ``<array>``   
         - string
-   
         - Can be any valid :ref:`expression <aggregation-expressions>` as long
           as it resolves to an array. For more information on expressions, see
           :ref:`aggregation-expressions`.
@@ -54,36 +49,24 @@ Definition
           If the array expression does not resolve to an array or ``null`` nor
           refers to a missing field, :expression:`$indexOfArray` returns an
           error.
-          
-          
-   
-      * - ``<search value>``
-   
+
+      * - ``<search value>``   
         - string
-   
         - Can be any valid :ref:`expression <aggregation-expressions>`. For
           more information on expressions, see :ref:`aggregation-expressions`.
-          
-          
 
       * - ``<start>``
-   
         - integer
-   
         - Optional. An integer, or a number that can be represented as integers (such as
           2.0), that specifies the starting index position for the search. Can
           be any valid :ref:`expression <aggregation-expressions>` that
           resolves to a non-negative integral number.
 
           If unspecified, the starting index position for the search is the
           beginning of the string.
-          
-          
-   
-      * - ``<end>``
-   
+
+      * - ``<end>``   
         - integer
-   
         - Optional. An integer, or a number that can be represented as integers (such as
           2.0), that specifies the ending index position for the search. Can
           be any valid :ref:`expression <aggregation-expressions>` that
@@ -94,10 +77,6 @@ Definition
 
           If unspecified, the ending index position for the search is the
           end of the string.
-          
-          
-   
-
 
 Behavior
 --------
@@ -169,44 +148,55 @@ position.
    * - ``{ $indexOfArray: [ "foo", "foo" ] }``
      - Error
 
-Examples
---------
+Example
+-------
 
-Consider an ``inventory`` collection with the following documents:
+The example uses this ``inventory`` collection:
 
 .. code-block:: javascript
 
-   { "_id" : 1, "items" : ["one", "two", "three"] }
-   { "_id" : 2, "items" : [1, 2, 3] }
-   { "_id" : 3, "items" : [null, null, 2] }
-   { "_id" : 4, "items" : null }
-   { "_id" : 5, "amount" : 3 }
+   db.inventory.insertMany( [
+      { _id: 0, items: [ "one", "two", "three" ] },
+      { _id: 1, items: [ 1, 2, 3 ] },
+      { _id: 2, items: [ 1, 2, 3, 2 ] },
+      { _id: 3, items: [ null, null, 2 ] },
+      { _id: 4, items: [ 2, null, null, 2 ] },
+      { _id: 5, items: null },
+      { _id: 6, amount: 3 }
+   ] )
 
-The following operation uses the :expression:`$indexOfArray` operator to
-return the array index at which the string ``foo`` is located in each ``items`` array:
+The following example uses :expression:`$indexOfArray` to find ``2`` in
+the ``items`` array:
 
 .. code-block:: javascript
 
-   db.inventory.aggregate(
-      [
-        {
-          $project:
-             {
-               index: { $indexOfArray: [ "$items", 2 ] },
-             }
-         }
-      ]
-   )
+   db.inventory.aggregate( [ {
+      $project: {
+         index: { $indexOfArray: [ "$items", 2 ] }
+      }
+   } ] )
 
-The operation returns the following results:
+The example returns:
 
-.. code-block:: javascript
+- The first array index for the value ``2`` in each ``items`` array, if
+  found. Array indexes start at ``0``.
+- ``-1`` for the index if ``2`` is not in the ``items`` array.
+- ``null`` for the index if ``items`` is not an array or ``items`` does
+  not exist.
 
-   { "_id" : 1, "index" : "-1" }
-   { "_id" : 2, "index" : "1" }
-   { "_id" : 3, "index" : "2" }
-   { "_id" : 4, "index" : null }
-   { "_id" : 5, "index" : null }
+Example output:
 
+.. code-block:: javascript
+   :copyable: false
+
+   [
+      { _id: 0, index: -1 },
+      { _id: 1, index: 1 },
+      { _id: 2, index: 1 },
+      { _id: 3, index: 2 },
+      { _id: 4, index: 0 },
+      { _id: 5, index: null },
+      { _id: 6, index: null }
+   ]
 
 .. seealso:: :expression:`$indexOfBytes`, :expression:`$indexOfCP`, and :expression:`$in`