Use extracts for option includes

Author: jmikola

docs/includes/extracts-bucket-option.yaml

@@ -0,0 +1,28 @@
+ref: bucket-option-readConcern
+source:
+  ref: common-option-readConcern
+  file: extracts-common-option.yaml
+replacement:
+  object: bucket
+---
+ref: bucket-option-readPreference
+source:
+  ref: common-option-readPreference
+  file: extracts-common-option.yaml
+replacement:
+  object: bucket
+---
+ref: bucket-option-typeMap
+source:
+  ref: common-option-typeMap
+  file: extracts-common-option.yaml
+replacement:
+  object: bucket
+---
+ref: bucket-option-writeConcern
+source:
+  ref: common-option-writeConcern
+  file: extracts-common-option.yaml
+replacement:
+  object: bucket
+...

docs/includes/extracts-client-option.yaml

@@ -0,0 +1,28 @@
+ref: client-option-readConcern
+source:
+  ref: common-option-readConcern
+  file: extracts-common-option.yaml
+replacement:
+  object: client
+---
+ref: client-option-readPreference
+source:
+  ref: common-option-readPreference
+  file: extracts-common-option.yaml
+replacement:
+  object: client
+---
+ref: client-option-typeMap
+source:
+  ref: common-option-typeMap
+  file: extracts-common-option.yaml
+replacement:
+  object: client
+---
+ref: client-option-writeConcern
+source:
+  ref: common-option-writeConcern
+  file: extracts-common-option.yaml
+replacement:
+  object: client
+...

docs/includes/extracts-collection-option.yaml

@@ -0,0 +1,38 @@
+ref: collection-option-collation
+source: 
+  ref: common-option-collation
+  file: extracts-common-option.yaml
+post: |
+  If the collation is unspecified but the collection has a default collation,
+  the operation uses the collation specified for the collection. If no
+  collation is specified for the collection or for the operation, MongoDB uses
+  the simple binary comparison used in prior versions for string comparisons.
+---
+ref: collection-option-readConcern
+source:
+  ref: common-option-readConcern
+  file: extracts-common-option.yaml
+replacement:
+  object: collection
+---
+ref: collection-option-readPreference
+source:
+  ref: common-option-readPreference
+  file: extracts-common-option.yaml
+replacement:
+  object: collection
+---
+ref: collection-option-typeMap
+source:
+  ref: common-option-typeMap
+  file: extracts-common-option.yaml
+replacement:
+  object: collection
+---
+ref: collection-option-writeConcern
+source:
+  ref: common-option-writeConcern
+  file: extracts-common-option.yaml
+replacement:
+  object: collection
+...

docs/includes/extracts-common-option.yaml

@@ -0,0 +1,69 @@
+ref: common-option-collation
+content: |
+  :manual:`Collation </reference/collation>` allows users to specify
+  language-specific rules for string comparison, such as rules for lettercase
+  and accent marks. When specifying collation, the ``locale`` field is
+  mandatory; all other collation fields are optional. For descriptions of the
+  fields, see :manual:`Collation Document </reference/collation/#collation-document>`.
+---
+ref: common-option-comment
+content: |
+  Enables users to specify an arbitrary comment to help trace the operation
+  through the :manual:`database profiler </reference/database-profiler>`,
+  :manual:`currentOp </reference/command/currentOp>` output, and
+  :manual:`logs </reference/log-messages>`.
+---
+ref: common-option-hint
+content: |
+  The index to use. Specify either the index name as a string or the index key
+  pattern as a document. If specified, then the query system will only consider
+  plans using the hinted index.
+---
+ref: common-option-let
+content: |
+  Map of parameter names and values. Values must be constant or closed
+  expressions that do not reference document fields. Parameters can then be
+  accessed as variables in an aggregate expression context (e.g. ``$$var``).
+
+  This is not supported for server versions prior to 5.0 and will result in an
+  exception at execution time if used.
+---
+ref: common-option-maxTimeMS
+content: |
+  The cumulative time limit in milliseconds for processing operations on the
+  cursor. MongoDB aborts the operation at the earliest following
+  :term:`interrupt point`.
+---
+ref: common-option-readConcern
+content: |
+  :manual:`Read concern </reference/read-concern>` to use for the operation.
+  Defaults to the {{object}}'s read concern.
+replacement:
+  object: object
+---
+ref: common-option-readPreference
+content: |
+  :manual:`Read preference </reference/read-preference>` to use for the
+  operation. Defaults to the {{object}}'s read preference.
+replacement:
+  object: object
+---
+ref: common-option-session
+content: |
+  Client session to associate with the operation.
+---
+ref: common-option-typeMap
+content: |
+  The :php:`type map <manual/en/mongodb.persistence.deserialization.php#mongodb.persistence.typemaps>`
+  to apply to cursors, which determines how BSON documents are converted to PHP
+  values. Defaults to the {{object}}'s type map.
+replacement:
+  object: object
+---
+ref: common-option-writeConcern
+content: |
+  :manual:`Write concern </reference/write-concern>` to use for the operation.
+  Defaults to the {{object}}'s write concern.
+replacement:
+  object: object
+...

docs/includes/extracts-database-option.yaml

@@ -0,0 +1,28 @@
+ref: database-option-readConcern
+source:
+  ref: common-option-readConcern
+  file: extracts-common-option.yaml
+replacement:
+  object: database
+---
+ref: database-option-readPreference
+source:
+  ref: common-option-readPreference
+  file: extracts-common-option.yaml
+replacement:
+  object: database
+---
+ref: database-option-typeMap
+source:
+  ref: common-option-typeMap
+  file: extracts-common-option.yaml
+replacement:
+  object: database
+---
+ref: database-option-writeConcern
+source:
+  ref: common-option-writeConcern
+  file: extracts-common-option.yaml
+replacement:
+  object: database
+...

docs/includes/option-collation.rst

@@ -22,11 +22,11 @@
 
    * - collation
      - array|object
-     - .. include:: /includes/option-collation.rst
+     - .. include:: /includes/extracts/common-option-collation.rst
 
    * - comment
      - mixed
-     - .. include:: /includes/option-comment.rst
+     - .. include:: /includes/extracts/common-option-comment.rst
 
        The comment can be any valid BSON type for server versions 4.4 and above.
        Earlier server versions only support string values.
@@ -92,11 +92,11 @@
 
    * - readConcern
      - :php:`MongoDB\\Driver\\ReadConcern <class.mongodb-driver-readconcern>`
-     - .. include:: /includes/option-readConcern.rst
+     - .. include:: /includes/extracts/common-option-readConcern.rst
 
    * - readPreference
      - :php:`MongoDB\\Driver\\ReadPreference <class.mongodb-driver-readpreference>`
-     - .. include:: /includes/option-readPreference.rst
+     - .. include:: /includes/extracts/common-option-readPreference.rst
 
        This is used for both the initial change stream aggregation and for
        server selection during an automatic resume.
@@ -117,7 +117,7 @@
 
    * - session
      - :php:`MongoDB\\Driver\\Session <class.mongodb-driver-session>`
-     - .. include:: /includes/option-session.rst
+     - .. include:: /includes/extracts/common-option-session.rst
 
    * - showExpandedEvents
      - boolean
@@ -182,4 +182,4 @@
 
    * - typeMap
      - array
-     - .. include:: /includes/option-typeMap.rst
+     - .. include:: /includes/extracts/common-option-typeMap.rst

docs/includes/option-comment.rst

@@ -30,8 +30,6 @@ Parameters
 ``$options`` : array
   An array specifying the desired options.
 
-  .. |parent| replace:: client
-
   .. list-table::
      :header-rows: 1
      :widths: 20 20 80
@@ -42,7 +40,7 @@ Parameters
 
      * - comment
        - mixed
-       - .. include:: /includes/option-comment.rst
+       - .. include:: /includes/extracts/common-option-comment.rst
 
          This is not supported for server versions prior to 4.4 and will result
          in an exception at execution time if used.
@@ -51,19 +49,19 @@ Parameters
 
      * - session
        - :php:`MongoDB\\Driver\\Session <class.mongodb-driver-session>`
-       - .. include:: /includes/option-session.rst
+       - .. include:: /includes/extracts/common-option-session.rst
 
          .. versionadded:: 1.3
 
      * - typeMap
        - array
-       - .. include:: /includes/option-typeMap.rst
+       - .. include:: /includes/extracts/client-option-typeMap.rst
 
          This will be used for the returned command result document.
 
      * - writeConcern
        - :php:`MongoDB\\Driver\\WriteConcern <class.mongodb-driver-writeconcern>`
-       - .. include:: /includes/option-writeConcern.rst
+       - .. include:: /includes/extracts/client-option-writeConcern.rst
 
 Return Values
 -------------

docs/includes/option-maxTimeMS.rst

@@ -49,7 +49,7 @@ Parameters
 
      * - comment
        - mixed
-       - .. include:: /includes/option-comment.rst
+       - .. include:: /includes/extracts/common-option-comment.rst
 
          This is not supported for server versions prior to 4.4 and will result
          in an exception at execution time if used.
@@ -67,11 +67,11 @@ Parameters
 
      * - maxTimeMS
        - integer
-       - .. include:: /includes/option-maxTimeMS.rst
+       - .. include:: /includes/extracts/common-option-maxTimeMS.rst
 
      * - session
        - :php:`MongoDB\\Driver\\Session <class.mongodb-driver-session>`
-       - .. include:: /includes/option-session.rst
+       - .. include:: /includes/extracts/common-option-session.rst
 
          .. versionadded:: 1.3
 

docs/includes/option-readConcern.rst

@@ -47,7 +47,7 @@ Parameters
 
      * - comment
        - mixed
-       - .. include:: /includes/option-comment.rst
+       - .. include:: /includes/extracts/common-option-comment.rst
 
          This is not supported for server versions prior to 4.4 and will result
          in an exception at execution time if used.
@@ -65,11 +65,11 @@ Parameters
 
      * - maxTimeMS
        - integer
-       - .. include:: /includes/option-maxTimeMS.rst
+       - .. include:: /includes/extracts/common-option-maxTimeMS.rst
 
      * - session
        - :php:`MongoDB\\Driver\\Session <class.mongodb-driver-session>`
-       - .. include:: /includes/option-session.rst
+       - .. include:: /includes/extracts/common-option-session.rst
 
          .. versionadded:: 1.3
 

docs/includes/option-readPreference.rst

@@ -57,13 +57,13 @@ Parameters
 
      * - typeMap
        - array
-       - .. |parent| replace:: client
-         .. include:: /includes/option-typeMap.rst
+       - The default type map to use for collection operations. Defaults to the
+         client's type map.
 
      * - writeConcern
        - :php:`MongoDB\\Driver\\WriteConcern <class.mongodb-driver-writeconcern>`
        - The default write concern to use for collection operations. Defaults to
-         to the client's write concern.
+         the client's write concern.
 
 Return Values
 -------------

docs/includes/option-session.rst

@@ -53,8 +53,8 @@ Parameters
 
      * - typeMap
        - array
-       - .. |parent| replace:: client
-         .. include:: /includes/option-typeMap.rst
+       - The default type map to use for database operations. Defaults to the
+         client's type map.
 
      * - writeConcern
        - :php:`MongoDB\\Driver\\WriteConcern <class.mongodb-driver-writeconcern>`

docs/includes/option-typeMap.rst

@@ -36,7 +36,6 @@ Parameters
 ``$options`` : array
   An array specifying the desired options.
 
-  .. |parent| replace:: client
   .. include:: /includes/watch-options.rst
 
 Return Values