[DRIVERS-2606] Simplify transaction options in convenient API doc example code Created: 14/Apr/23 Updated: 21/Aug/23 |
|
| Status: | Implementing |
| Project: | Drivers |
| Component/s: | Docs Examples |
| Fix Version/s: | None |
| Type: | Task | Priority: | Unknown |
| Reporter: | Jeremy Mikola | Assignee: | Unassigned |
| 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: | Teams will need to update their documentation examples for transactions. After each language ticket is merged, the assignee should then open a new DOCSP ticket with a "Server" component to inform the docs team to pull in the updated examples. The above pertains to language-specific examples that are rendered in the MongoDB manual. Any docs owned by the language team can be directly updated. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Start date: | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Driver Compliance: |
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Description |
SummaryWhat is the problem or use case, what are we trying to achieve? The Convenient API for Transactions examples in the MongoDB manual use the following options:
These no longer seem relevant and I propose removing them.
This came up while reviewing the Unit 2 Lesson 6 script for upcoming PHP courses, which copied with_transaction() examples from MotivationWho is the affected end user?Documentation readers. How does this affect the end user?The documentation may be unnecessarily verbose. Is this issue urgent?No. Is this ticket required by a downstream team?The docs team would need to be informed to republish language examples after drivers implement this change. Is this ticket only for tests?Yes (since documentation examples are run in driver test suites). |