[DRIVERS-2462] Use field list syntax for CSFLE spec changelog Created: 06/Oct/22  Updated: 28/Oct/23  Resolved: 07/Nov/22

Status: Closed
Project: Drivers
Component/s: Client Side Encryption
Fix Version/s: None

Type: Task Priority: Unknown
Reporter: Jeremy Mikola Assignee: Jeremy Mikola
Resolution: Fixed Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

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

 Description   

Summary

In DRIVERS-2253, I converted most spec changelogs to use Field Lists but left the CSFLE spec as-is since it uniquely utilized CSV table formatting. If consistency is desired, I would suggest porting the CSV 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 Githook User [ 07/Nov/22 ]

Author:

{'name': 'Jeremy Mikola', 'email': 'jmikola@gmail.com', 'username': 'jmikola'}

Message: DRIVERS-2462: Reformat CSFLE spec changelog (#1339)
Branch: master
https://github.com/mongodb/specifications/commit/d13c61d988c5af11a94028aee46d5adb2f62df52

Comment by Jeremy Mikola [ 03/Nov/22 ]

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

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