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

Relax the CMAP documentation requirement for durations in events

XMLWordPrintableJSON

    • Type: Icon: Bug Bug
    • Resolution: Unresolved
    • Priority: Icon: Unknown Unknown
    • None
    • Component/s: CMAP
    • None
    • Needed
    • Hide

      Update the driver implementation and documentation of CMAP event durations according to the specification changes in https://github.com/mongodb/specifications/pull/1455.

      Show
      Update the driver implementation and documentation of CMAP event durations according to the specification changes in https://github.com/mongodb/specifications/pull/1455 .
    • $i18n.getText("admin.common.words.hide")
      Key Status/Resolution FixVersion
      CDRIVER-4712 Won't Do
      CXX-2739 Won't Do
      CSHARP-4774 Works as Designed
      GODRIVER-2961 Backlog
      JAVA-5121 Done 5.0.0
      NODE-5589 Duplicate
      MOTOR-1179 Duplicate
      PYTHON-3941 Backlog
      PHPLIB-1222 Won't Do
      RUBY-3320 Blocked
      RUST-1742 Fixed 2.8.0
      $i18n.getText("admin.common.words.show")
      #scriptField, #scriptField *{ border: 1px solid black; } #scriptField{ border-collapse: collapse; } #scriptField td { text-align: center; /* Center-align text in table cells */ } #scriptField td.key { text-align: left; /* Left-align text in the Key column */ } #scriptField a { text-decoration: none; /* Remove underlines from links */ border: none; /* Remove border from links */ } /* Add green background color to cells with FixVersion */ #scriptField td.hasFixVersion { background-color: #00FF00; /* Green color code */ } /* Center-align the first row headers */ #scriptField th { text-align: center; } Key Status/Resolution FixVersion CDRIVER-4712 Won't Do CXX-2739 Won't Do CSHARP-4774 Works as Designed GODRIVER-2961 Backlog JAVA-5121 Done 5.0.0 NODE-5589 Duplicate MOTOR-1179 Duplicate PYTHON-3941 Backlog PHPLIB-1222 Won't Do RUBY-3320 Blocked RUST-1742 Fixed 2.8.0

      Summary

      In this commit, for DRIVERS-2469, we added the wording "The driver MUST document this behavior as well as explicitly warn users that the behavior may change in the future." Discussed in the Java implementation. It seems that specs should not require (or suggest) that a public API be documented as subject to change (or that implementation details be documented.

      I propose that we commit to the (reasonable) specified behaviour. If not, then remove the requirement to doc it.

      Motivation

      Who is the affected end user?

      Users who read driver docs

      How does this affect the end user?

      Cannot rely on documented behaviour

      How likely is it that this problem or use case will occur?

      Unlikely

      If the problem does occur, what are the consequences and how severe are they?

      Trivial

      Is this issue urgent?

      No, but it is opportune to fix this now since it is in progress.

      Is this ticket required by a downstream team?

      No

      Is this ticket only for tests?

      Neither, just docs

      Acceptance Criteria

      The requirement to document public behaviour as tentative is removed.

            Assignee:
            valentin.kovalenko@mongodb.com Valentin Kavalenka
            Reporter:
            maxim.katcharov@mongodb.com Maxim Katcharov
            Jeffrey Yemin Jeffrey Yemin
            Tom Selander Tom Selander
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

              Created:
              Updated: