Skip to content

Commit 9e6e0cc

Browse files
alcaeusjmikola
andauthored
PHPLIB-690 Update documentation for time series collection options (#843)
* PHPLIB-690 Update documentation for time series collection options * Apply suggestions from code review Co-authored-by: Jeremy Mikola <[email protected]> Co-authored-by: Jeremy Mikola <[email protected]>
1 parent a5e78be commit 9e6e0cc

File tree

2 files changed

+7
-3
lines changed

2 files changed

+7
-3
lines changed

Diff for: docs/includes/apiargs-MongoDBDatabase-method-createCollection-option.yaml

+6-3
Original file line numberDiff line numberDiff line change
@@ -38,8 +38,9 @@ arg_name: option
3838
name: expireAfterSeconds
3939
type: integer
4040
description: |
41-
Allows specifying a TTL after which documents will be removed from a
42-
time-series collection.
41+
Used to automatically delete documents in time series collections. See the
42+
:manual:`create </reference/command/create>` command documentation for more
43+
information.
4344
4445
This option is available in MongoDB 5.0+ and will result in an exception at
4546
execution time if specified for an older server version.
@@ -152,7 +153,9 @@ arg_name: option
152153
name: timeseries
153154
type: array|object
154155
description: |
155-
Allows users to specify options for time-series collections.
156+
An object containing options for creating time series collections. See the
157+
:manual:`create </reference/command/create>` command documentation for
158+
supported options.
156159
157160
This option is available in MongoDB 5.0+ and will result in an exception at
158161
execution time if specified for an older server version.

Diff for: docs/reference/method/MongoDBDatabase-createCollection.txt

+1
Original file line numberDiff line numberDiff line change
@@ -97,3 +97,4 @@ See Also
9797
- :manual:`create </reference/command/create>` command reference in the MongoDB
9898
manual
9999
- :manual:`db.createCollection() </reference/method/db.createCollection>`
100+
- :manual:`Time Series Collections </core/timeseries-collections>`

0 commit comments

Comments
 (0)