Use extracts for repeated option notes

Author: jmikola

docs/includes/extracts-common-option.yaml

@@ -13,6 +13,11 @@ content: |
   :manual:`currentOp </reference/command/currentOp>` output, and
   :manual:`logs </reference/log-messages>`.
 ---
+ref: common-option-comment-string-before-4.4
+content: |
+  The comment can be any valid BSON type since MongoDB 4.4. Earlier server
+  versions only support string values.
+---
 ref: common-option-hint
 content: |
   The index to use. Specify either the index name as a string or the index key
@@ -41,6 +46,12 @@ content: |
 replacement:
   object: object
 ---
+ref: common-option-readConcern-transaction
+content: |
+  It is not possible to specify a read concern for individual operations as part
+  of a transaction. Instead, set the ``readConcern`` option when
+  :php:`starting the transaction <mongodb-driver-session.starttransaction>`.
+---
 ref: common-option-readPreference
 content: |
   :manual:`Read preference </reference/read-preference>` to use for the
@@ -66,4 +77,10 @@ content: |
   Defaults to the {{object}}'s write concern.
 replacement:
   object: object
+---
+ref: common-option-writeConcern-transaction
+content: |
+  It is not possible to specify a write concern for individual operations as
+  part of a transaction. Instead, set the ``writeConcern`` option when
+  :php:`starting the transaction <mongodb-driver-session.starttransaction>`.
 ...

docs/includes/extracts-option-requires.yaml

@@ -0,0 +1,48 @@
+---
+ref: option-requires-4.2
+source:
+  ref: option-requires-version
+  file: extracts-option-requires.yaml
+replacement:
+  version: "4.2"
+---
+ref: option-requires-4.4
+source:
+  ref: option-requires-version
+  file: extracts-option-requires.yaml
+replacement:
+  version: "4.4"
+---
+ref: option-requires-5.0
+source:
+  ref: option-requires-version
+  file: extracts-option-requires.yaml
+replacement:
+  version: "5.0"
+---
+ref: option-requires-5.3
+source:
+  ref: option-requires-version
+  file: extracts-option-requires.yaml
+replacement:
+  version: "5.3"
+---
+ref: option-requires-6.0
+source:
+  ref: option-requires-version
+  file: extracts-option-requires.yaml
+replacement:
+  version: "6.0"
+---
+ref: option-requires-7.0
+source:
+  ref: option-requires-version
+  file: extracts-option-requires.yaml
+replacement:
+  version: "7.0"
+---
+ref: option-requires-version
+content: |
+  This option is available since MongoDB {{version}} and will result in an
+  exception at execution time if specified for an older server version.
+...

docs/reference/method/MongoDBClient-dropDatabase.txt

@@ -42,8 +42,7 @@ Parameters
        - mixed
        - .. 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.
+         .. include:: /includes/extracts/option-requires-4.4.rst
 
          .. versionadded:: 1.13
 

docs/reference/method/MongoDBClient-listDatabaseNames.txt

@@ -51,8 +51,7 @@ Parameters
        - mixed
        - .. 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.
+         .. include:: /includes/extracts/option-requires-4.4.rst
 
          .. versionadded:: 1.13
 

docs/reference/method/MongoDBClient-listDatabases.txt

@@ -49,8 +49,7 @@ Parameters
        - mixed
        - .. 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.
+         .. include:: /includes/extracts/option-requires-4.4.rst
 
          .. versionadded:: 1.13
 

docs/reference/method/MongoDBClient-watch.txt

@@ -56,8 +56,7 @@ Parameters
        - mixed
        - .. 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.
+         .. include:: /includes/extracts/common-option-comment-string-before-4.4.rst
 
          .. versionadded:: 1.13
 

docs/reference/method/MongoDBCollection-aggregate.txt

@@ -110,10 +110,7 @@ Parameters
        - :php:`MongoDB\\Driver\\ReadConcern <class.mongodb-driver-readconcern>`
        - .. include:: /includes/extracts/collection-option-readConcern.rst
 
-         It is not possible to specify a :manual:`read concern
-         </reference/read-concern>` for individual operations as part of a
-         transaction. Instead, set the ``readConcern`` option when starting the
-         transaction with :php:`startTransaction <mongodb-driver-session.starttransaction>`.
+         .. include:: /includes/extracts/common-option-readConcern-transaction.rst
 
      * - readPreference
        - :php:`MongoDB\\Driver\\ReadPreference <class.mongodb-driver-readpreference>`
@@ -133,10 +130,7 @@ Parameters
        - :php:`MongoDB\\Driver\\WriteConcern <class.mongodb-driver-writeconcern>`
        - .. include:: /includes/extracts/collection-option-writeConcern.rst
 
-         It is not possible to specify a :manual:`write concern
-         </reference/write-concern>` for individual operations as part of a
-         transaction. Instead, set the ``writeConcern`` option when starting the
-         transaction with :php:`startTransaction <mongodb-driver-session.starttransaction>`.
+         .. include:: /includes/extracts/common-option-writeConcern-transaction.rst
 
          This only applies when a :ref:`$out <agg-out>` or
          :ref:`$merge <agg-merge>` stage is specified.

docs/reference/method/MongoDBCollection-bulkWrite.txt

@@ -74,8 +74,7 @@ Parameters
        - mixed
        - .. 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.
+         .. include:: /includes/extracts/option-requires-4.4.rst
 
          .. versionadded:: 1.13
 
@@ -105,10 +104,7 @@ Parameters
        - :php:`MongoDB\\Driver\\WriteConcern <class.mongodb-driver-writeconcern>`
        - .. include:: /includes/extracts/collection-option-writeConcern.rst
 
-         It is not possible to specify a :manual:`write concern
-         </reference/write-concern>` for individual operations as part of a
-         transaction. Instead, set the ``writeConcern`` option when starting the
-         transaction with :php:`startTransaction <mongodb-driver-session.starttransaction>`.
+         .. include:: /includes/extracts/common-option-writeConcern-transaction.rst
 
 Return Values
 -------------

docs/reference/method/MongoDBCollection-count.txt

@@ -51,8 +51,7 @@ Parameters
        - mixed
        - .. 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.
+         .. include:: /includes/extracts/option-requires-4.4.rst
 
          .. versionadded:: 1.13
 
@@ -78,10 +77,7 @@ Parameters
        - :php:`MongoDB\\Driver\\ReadConcern <class.mongodb-driver-readconcern>`
        - .. include:: /includes/extracts/collection-option-readConcern.rst
 
-         It is not possible to specify a :manual:`read concern
-         </reference/read-concern>` for individual operations as part of a
-         transaction. Instead, set the ``readConcern`` option when starting the
-         transaction with :php:`startTransaction <mongodb-driver-session.starttransaction>`.
+         .. include:: /includes/extracts/common-option-readConcern-transaction.rst
 
      * - readPreference
        - :php:`MongoDB\\Driver\\ReadPreference <class.mongodb-driver-readpreference>`

docs/reference/method/MongoDBCollection-countDocuments.txt

@@ -48,8 +48,7 @@ Parameters
        - mixed
        - .. 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.
+         .. include:: /includes/extracts/common-option-comment-string-before-4.4.rst
 
      * - hint
        - string|array|object
@@ -67,10 +66,7 @@ Parameters
        - :php:`MongoDB\\Driver\\ReadConcern <class.mongodb-driver-readconcern>`
        - .. include:: /includes/extracts/collection-option-readConcern.rst
 
-         It is not possible to specify a :manual:`read concern
-         </reference/read-concern>` for individual operations as part of a
-         transaction. Instead, set the ``readConcern`` option when starting the
-         transaction with :php:`startTransaction <mongodb-driver-session.starttransaction>`.
+         .. include:: /includes/extracts/common-option-readConcern-transaction.rst
 
      * - readPreference
        - :php:`MongoDB\\Driver\\ReadPreference <class.mongodb-driver-readpreference>`

docs/reference/method/MongoDBCollection-createIndex.txt

@@ -91,8 +91,7 @@ Parameters
        - mixed
        - .. 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.
+         .. include:: /includes/extracts/option-requires-4.4.rst
 
          .. versionadded:: 1.13
 
@@ -127,10 +126,7 @@ Parameters
        - :php:`MongoDB\\Driver\\WriteConcern <class.mongodb-driver-writeconcern>`
        - .. include:: /includes/extracts/collection-option-writeConcern.rst
 
-         It is not possible to specify a :manual:`write concern
-         </reference/write-concern>` for individual operations as part of a
-         transaction. Instead, set the ``writeConcern`` option when starting the
-         transaction with :php:`startTransaction <mongodb-driver-session.starttransaction>`.
+         .. include:: /includes/extracts/common-option-writeConcern-transaction.rst
 
 Return Values
 -------------

docs/reference/method/MongoDBCollection-createIndexes.txt

@@ -55,22 +55,22 @@ Parameters
        - mixed
        - .. 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.
+         .. include:: /includes/extracts/option-requires-4.4.rst
 
          .. versionadded:: 1.13
 
      * - commitQuorum
        - string|integer
        - Specifies how many data-bearing members of a replica set, including the
-         primary, must complete the index builds successfully before the primary marks
-         the indexes as ready.
+         primary, must complete the index builds successfully before the primary
+         marks the indexes as ready.
 
-         This option accepts the same values for the ``w`` field in a write concern
-         plus ``"votingMembers"``, which indicates all voting data-bearing nodes.
+         This option accepts the same values for the ``w`` field in a write
+         concern plus ``"votingMembers"``, which indicates all voting
+         data-bearing nodes.
 
-         This is not supported for server versions prior to 4.4 and will result in an
-         exception at execution time if used.
+         This is not supported for server versions prior to 4.4 and will result
+         in an exception at execution time if used.
 
          .. versionadded:: 1.7
 
@@ -90,10 +90,7 @@ Parameters
        - :php:`MongoDB\\Driver\\WriteConcern <class.mongodb-driver-writeconcern>`
        - .. include:: /includes/extracts/collection-option-writeConcern.rst
 
-         It is not possible to specify a :manual:`write concern
-         </reference/write-concern>` for individual operations as part of a
-         transaction. Instead, set the ``writeConcern`` option when starting the
-         transaction with :php:`startTransaction <mongodb-driver-session.starttransaction>`.
+         .. include:: /includes/extracts/common-option-writeConcern-transaction.rst
 
 Return Values
 -------------

docs/reference/method/MongoDBCollection-deleteMany.txt

@@ -49,17 +49,15 @@ Parameters
        - mixed
        - .. 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.
+         .. include:: /includes/extracts/option-requires-4.4.rst
 
          .. versionadded:: 1.13
 
      * - hint
        - string|array|object
        - .. include:: /includes/extracts/common-option-hint.rst
 
-         This option is available in MongoDB 4.4+ and will result in an
-         exception at execution time if specified for an older server version.
+         .. include:: /includes/extracts/option-requires-4.4.rst
 
          .. versionadded:: 1.7
 
@@ -79,10 +77,7 @@ Parameters
        - :php:`MongoDB\\Driver\\WriteConcern <class.mongodb-driver-writeconcern>`
        - .. include:: /includes/extracts/collection-option-writeConcern.rst
 
-         It is not possible to specify a :manual:`write concern
-         </reference/write-concern>` for individual operations as part of a
-         transaction. Instead, set the ``writeConcern`` option when starting the
-         transaction with :php:`startTransaction <mongodb-driver-session.starttransaction>`.
+         .. include:: /includes/extracts/common-option-writeConcern-transaction.rst
 
 Return Values
 -------------

docs/reference/method/MongoDBCollection-deleteOne.txt

@@ -51,17 +51,15 @@ Parameters
        - mixed
        - .. 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.
+         .. include:: /includes/extracts/option-requires-4.4.rst
 
          .. versionadded:: 1.13
 
      * - hint
        - string|array|object
        - .. include:: /includes/extracts/common-option-hint.rst
 
-         This option is available in MongoDB 4.4+ and will result in an exception at
-         execution time if specified for an older server version.
+         .. include:: /includes/extracts/option-requires-4.4.rst
 
          .. versionadded:: 1.7
 
@@ -81,10 +79,7 @@ Parameters
        - :php:`MongoDB\\Driver\\WriteConcern <class.mongodb-driver-writeconcern>`
        - .. include:: /includes/extracts/collection-option-writeConcern.rst
 
-         It is not possible to specify a :manual:`write concern
-         </reference/write-concern>` for individual operations as part of a
-         transaction. Instead, set the ``writeConcern`` option when starting the
-         transaction with :php:`startTransaction <mongodb-driver-session.starttransaction>`.
+         .. include:: /includes/extracts/common-option-writeConcern-transaction.rst
 
 Return Values
 -------------

docs/reference/method/MongoDBCollection-distinct.txt

@@ -54,8 +54,7 @@ Parameters
        - mixed
        - .. 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.
+         .. include:: /includes/extracts/option-requires-4.4.rst
 
          .. versionadded:: 1.13
 
@@ -67,10 +66,7 @@ Parameters
        - :php:`MongoDB\\Driver\\ReadConcern <class.mongodb-driver-readconcern>`
        - .. include:: /includes/extracts/collection-option-readConcern.rst
 
-         It is not possible to specify a :manual:`read concern
-         </reference/read-concern>` for individual operations as part of a
-         transaction. Instead, set the ``readConcern`` option when starting the
-         transaction with :php:`startTransaction <mongodb-driver-session.starttransaction>`.
+         .. include:: /includes/extracts/common-option-readConcern-transaction.rst
 
      * - readPreference
        - :php:`MongoDB\\Driver\\ReadPreference <class.mongodb-driver-readpreference>`

docs/reference/method/MongoDBCollection-drop.txt

@@ -39,8 +39,7 @@ Parameters
        - mixed
        - .. 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.
+         .. include:: /includes/extracts/option-requires-4.4.rst
 
          .. versionadded:: 1.13
 
@@ -80,10 +79,7 @@ Parameters
        - :php:`MongoDB\\Driver\\WriteConcern <class.mongodb-driver-writeconcern>`
        - .. include:: /includes/extracts/collection-option-writeConcern.rst
 
-         It is not possible to specify a :manual:`write concern
-         </reference/write-concern>` for individual operations as part of a
-         transaction. Instead, set the ``writeConcern`` option when starting the
-         transaction with :php:`startTransaction <mongodb-driver-session.starttransaction>`.
+         .. include:: /includes/extracts/common-option-writeConcern-transaction.rst