[CXX-1302] Documentation for read_concern::acknowledge_string() should clarify that any read concern string can be passed in Created: 06/Apr/17  Updated: 05/Jul/17  Resolved: 02/May/17

Status: Closed
Project: C++ Driver
Component/s: Documentation
Affects Version/s: None
Fix Version/s: 3.2.0-rc0

Type: Bug Priority: Major - P3
Reporter: J Rassi Assignee: Samuel Rossi (Inactive)
Resolution: Done Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
Related
is related to CDRIVER-2122 Issues in documentation for read conc... Closed

 Description   

The current documentation for read_concern::acknowledge_string() states that the parameter "rc_string" needs to be 'One of "local", "majority", "linearizable", or ""'. For better compliance with the Read and Write Concern spec (section "Unknown Levels and Additional Options for String Based ReadConcerns"), we should clarify that any read concern string can be passed in.

In addition, since our code/documentation assumes that "local" translates to MONGOC_READ_CONCERN_LEVEL_LOCAL / etc, we should consider adding static assertions to this effect, to reduce the risk of regressions introduced due to possible future changes in the C driver.



 Comments   
Comment by Githook User [ 02/May/17 ]

Author:

{u'username': u'saghm', u'name': u'Saghm Rossi', u'email': u'saghmrossi@gmail.com'}

Message: CXX-1302 Documentation for read_concern::acknowledge_string() should clarify that any read concern string can be passed in
Branch: master
https://github.com/mongodb/mongo-cxx-driver/commit/fbcae556fdbe1e7509825ea93fce3b3897613c71

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