[CXX-1839] Improve tutorial for mongocxx documentation Created: 08/Oct/19  Updated: 07/Feb/24

Status: Backlog
Project: C++ Driver
Component/s: Documentation
Affects Version/s: None
Fix Version/s: None

Type: Improvement Priority: Major - P3
Reporter: Clyde Bazile III (Inactive) Assignee: Unassigned
Resolution: Unresolved Votes: 0
Labels: internal-woes, size-small
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Epic Link: Reference Docs Improvements
Quarter: FY24Q4
Backwards Compatibility: Minor Change

 Description   

The lack of documentation is problematic when learning how to use MongoDB and the driver. I found myself reading the source code instead of the documentation to figure out crucial things such as:

*

Which methods are safe to call across different threads?

  • What objects can be passed between threads?

  • Which methods throw exceptions, and why?

  • Which objects represent ownership? The distinction between value/view on the bsoncxx side suggests awareness of this, but was hard to figure out for other objects, such as client, connection, pool, transaction, etc.


Generated at Wed Feb 07 22:04:05 UTC 2024 using Jira 9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66.