-
Type: Bug
-
Resolution: Unresolved
-
Priority: Unknown
-
None
-
Component/s: CMAP
-
None
-
Needed
-
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.
- has to be finished together with
-
DRIVERS-2469 Add durations to connection pool events
- Implementing
- is caused by
-
DRIVERS-2469 Add durations to connection pool events
- Implementing
- split to
-
GODRIVER-2961 Relax the CMAP documentation requirement for durations in events
- Backlog
-
PYTHON-3941 Relax the CMAP documentation requirement for durations in events
- Backlog
-
RUBY-3320 Relax the CMAP documentation requirement for durations in events
- Blocked
-
CDRIVER-4712 Relax the CMAP documentation requirement for durations in events
- Closed
-
CSHARP-4774 Relax the CMAP documentation requirement for durations in events
- Closed
-
CXX-2739 Relax the CMAP documentation requirement for durations in events
- Closed
-
MOTOR-1179 Relax the CMAP documentation requirement for durations in events
- Closed
-
NODE-5589 Relax the CMAP documentation requirement for durations in events
- Closed
-
PHPLIB-1222 Relax the CMAP documentation requirement for durations in events
- Closed
-
RUST-1742 Relax the CMAP documentation requirement for durations in events
- Closed
-
JAVA-5121 Relax the CMAP documentation requirement for durations in events
- Closed
- links to