[DRIVERS-2707] Relax the CMAP documentation requirement for durations in events Created: 25/Aug/23 Updated: 09/Jan/24 |
|
| Status: | Implementing |
| Project: | Drivers |
| Component/s: | CMAP |
| Fix Version/s: | None |
| Type: | Bug | Priority: | Unknown |
| Reporter: | Maxim Katcharov | Assignee: | Valentin Kavalenka |
| Resolution: | Unresolved | Votes: | 0 |
| Labels: | None | ||
| Remaining Estimate: | Not Specified | ||
| Time Spent: | Not Specified | ||
| Original Estimate: | Not Specified | ||
| Issue Links: |
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Driver Changes: | Needed | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Downstream Changes Summary: | Update the driver implementation and documentation of CMAP event durations according to the specification changes in https://github.com/mongodb/specifications/pull/1455. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Engineering Lead: | |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Program Manager: | |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Start date: | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Driver Compliance: |
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Description |
SummaryIn 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. MotivationWho 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 CriteriaThe requirement to document public behaviour as tentative is removed. |
| Comments |
| Comment by Githook User [ 10/Oct/23 ] |
|
Author: {'name': 'Valentin Kovalenko', 'email': 'valentin.kovalenko@mongodb.com', 'username': 'stIncMale'}Message: DRIVERS-2707 Relax the CMAP documentation requirement for durations in events (#1455) --------- Co-authored-by: Bailey Pearson <bailey.pearson@gmail.com> |