-
Type: Task
-
Resolution: Fixed
-
Priority: Unknown
-
None
-
Component/s: Client Side Encryption
-
None
-
Not Needed
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.
- is related to
-
DRIVERS-2253 Remove spec versions and front matter
- Closed
-
DRIVERS-2461 Use field list syntax for Change Stream spec changelog
- Closed