Uploaded image for project: 'Drivers'
  1. Drivers
  2. DRIVERS-2461

Use field list syntax for Change Stream spec changelog

    • Type: Icon: Task Task
    • Resolution: Done
    • Priority: Icon: Unknown Unknown
    • None
    • Component/s: Change Streams
    • Labels:
      None
    • Not Needed

      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.

            Assignee:
            benji.rewis@mongodb.com Benji Rewis (Inactive)
            Reporter:
            jmikola@mongodb.com Jeremy Mikola
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

              Created:
              Updated:
              Resolved: