[DRIVERS-2461] Use field list syntax for Change Stream spec changelog Created: 06/Oct/22  Updated: 21/Oct/22  Resolved: 21/Oct/22

Status: Closed
Project: Drivers
Component/s: Change Streams
Fix Version/s: None

Type: Task Priority: Unknown
Reporter: Jeremy Mikola Assignee: Benji Rewis (Inactive)
Resolution: Done Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
Related
related to DRIVERS-2462 Use field list syntax for CSFLE spec ... Closed
is related to DRIVERS-2253 Remove spec versions and front matter Closed
Driver Changes: Not Needed

 Description   

Summary

In DRIVERS-2253, I converted most spec changelogs to use Field Lists but left the Change Streams spec as-is since it uniquely utilized grid table formatting. If consistency is desired, I would suggest porting the grid table syntax over to field lists:

Changelog
---------
 
:YYYY-MM-DD: RST field list syntax is suggested for changelogs.
:YYYY-MM-DD: Specs vary in using ascending or descending order for changelog
             entries. Maintain consistency when updating a spec's changelog.
:YYYY-MM-DD: A changelog entry may span multiple lines, which should be aligned
             with the date when wrapping.
:YYYY-MM-DD: * A changelog entry may use lists
             * Longer list entries may also be used and should be aligned with
               the bullet character when wrapping.

If this is not desired, feel free to close this issue.

Motivation

Who is the affected end user?

Spec editors.

How does this affect the end user?

Consistent RST syntax with other spec documents.

Is this issue urgent?

No.

Is this ticket required by a downstream team?

No.

Is this ticket only for tests?

No.



 Comments   
Comment by Benji Rewis (Inactive) [ 21/Oct/22 ]

Switched to the field-list syntax, thanks jmikola@mongodb.com.

Comment by Githook User [ 21/Oct/22 ]

Author:

{'name': 'Benjamin Rewis', 'email': '32186188+benjirewis@users.noreply.github.com', 'username': 'benjirewis'}

Message: DRIVERS-2461: Reformat change stream spec Changelog. (#1326)
Branch: master
https://github.com/mongodb/specifications/commit/da9c3533181066303496f271a197b96a8eef324a

Comment by Benji Rewis (Inactive) [ 20/Oct/22 ]

https://github.com/mongodb/specifications/pull/1326

Generated at Thu Feb 08 08:25:38 UTC 2024 using Jira 9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66.