PHPLIB-749: Support comment option on command helpers (#925)

Co-authored-by: Jeremy Mikola <[email protected]>

Author: aleksandr-rudo

docs/includes/apiargs-MongoDBClient-method-dropDatabase-option.yaml

@@ -1,3 +1,12 @@
+source:
+  file: apiargs-common-option.yaml
+  ref: comment
+post: |
+  This is not supported for server versions prior to 4.4 and will result in an
+  exception at execution time if used.
+
+  .. versionadded:: 1.13
+---
 source:
   file: apiargs-common-option.yaml
   ref: session

docs/includes/apiargs-MongoDBClient-method-listDatabases-option.yaml

@@ -13,6 +13,15 @@ interface: phpmethod
 operation: ~
 optional: true
 ---
+source:
+  file: apiargs-common-option.yaml
+  ref: comment
+post: |
+  This is not supported for server versions prior to 4.4 and will result in an
+  exception at execution time if used.
+
+  .. versionadded:: 1.13
+---
 arg_name: option
 name: filter
 type: array|object

docs/includes/apiargs-MongoDBClient-method-watch-option.yaml

@@ -7,6 +7,15 @@ source:
   file: apiargs-common-option.yaml
   ref: collation
 ---
+source:
+  file: apiargs-common-option.yaml
+  ref: comment
+post: |
+  The comment can be any valid BSON type for server versions 4.4 and above.
+  Earlier server versions only support string values.
+
+  .. versionadded:: 1.13
+---
 source:
   file: apiargs-method-watch-option.yaml
   ref: fullDocument

docs/includes/apiargs-MongoDBCollection-method-aggregate-option.yaml

@@ -11,9 +11,12 @@ source:
   ref: bypassDocumentValidation
 ---
 source:
-  file: apiargs-aggregate-option.yaml
+  file: apiargs-common-option.yaml
   ref: comment
 post: |
+  The comment can be any valid BSON type for server versions 4.4 and above.
+  Earlier server versions only support string values.
+
   .. versionadded:: 1.3
 ---
 source:

docs/includes/apiargs-MongoDBCollection-method-bulkWrite-option.yaml

@@ -2,6 +2,15 @@ source:
   file: apiargs-MongoDBCollection-common-option.yaml
   ref: bypassDocumentValidation
 ---
+source:
+  file: apiargs-common-option.yaml
+  ref: comment
+post: |
+  This is not supported for server versions prior to 4.4 and will result in an
+  exception at execution time if used.
+
+  .. versionadded:: 1.13
+---
 source:
   file: apiargs-common-option.yaml
   ref: let

docs/includes/apiargs-MongoDBCollection-method-count-option.yaml

@@ -2,6 +2,15 @@ source:
   file: apiargs-MongoDBCollection-common-option.yaml
   ref: collation
 ---
+source:
+  file: apiargs-common-option.yaml
+  ref: comment
+post: |
+  This is not supported for server versions prior to 4.4 and will result in an
+  exception at execution time if used.
+
+  .. versionadded:: 1.13
+---
 arg_name: option
 name: hint
 type: string|array|object

docs/includes/apiargs-MongoDBCollection-method-countDocuments-option.yaml

@@ -2,6 +2,13 @@ source:
   file: apiargs-MongoDBCollection-common-option.yaml
   ref: collation
 ---
+source:
+  file: apiargs-common-option.yaml
+  ref: comment
+post: |
+  The comment can be any valid BSON type for server versions 4.4 and above.
+  Earlier server versions only support string values.
+---
 arg_name: option
 name: hint
 type: string|array|object

docs/includes/apiargs-MongoDBCollection-method-createIndex-option.yaml

@@ -17,6 +17,15 @@ interface: phpmethod
 operation: ~
 optional: true
 ---
+source:
+  file: apiargs-common-option.yaml
+  ref: comment
+post: |
+  This is not supported for server versions prior to 4.4 and will result in an
+  exception at execution time if used.
+
+  .. versionadded:: 1.13
+---
 arg_name: option
 name: unique
 type: boolean

docs/includes/apiargs-MongoDBCollection-method-createIndexes-option.yaml

@@ -1,3 +1,12 @@
+source:
+  file: apiargs-common-option.yaml
+  ref: comment
+post: |
+  This is not supported for server versions prior to 4.4 and will result in an
+  exception at execution time if used.
+
+  .. versionadded:: 1.13
+---
 source:
   file: apiargs-MongoDBCollection-method-createIndex-option.yaml
   ref: commitQuorum

docs/includes/apiargs-MongoDBCollection-method-deleteMany-option.yaml

@@ -2,6 +2,15 @@ source:
   file: apiargs-MongoDBCollection-common-option.yaml
   ref: collation
 ---
+source:
+  file: apiargs-common-option.yaml
+  ref: comment
+post: |
+  This is not supported for server versions prior to 4.4 and will result in an
+  exception at execution time if used.
+
+  .. versionadded:: 1.13
+---
 source:
   file: apiargs-common-option.yaml
   ref: hint