Uploaded image for project: 'C++ Driver'
  1. C++ Driver
  2. CXX-1302

Documentation for read_concern::acknowledge_string() should clarify that any read concern string can be passed in

    XMLWordPrintable

    Details

    • Type: Bug
    • Status: Closed
    • Priority: Major - P3
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: 3.2.0-rc0
    • Component/s: Documentation
    • Labels:
      None
    • Story Points:
      0.5
    • Sprint:
      Perl/CXX 2017-05-05

      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.

        Attachments

          Issue Links

            Activity

              People

              • Votes:
                0 Vote for this issue
                Watchers:
                2 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved: