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

improve documentation of element::bool()

    XMLWordPrintable

    Details

    • Type: Improvement
    • Status: Closed
    • Priority: Minor - P4
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: 3.4.0
    • Component/s: BSON
    • Labels:
      None
    • Backwards Compatibility:
      Fully Compatible

      Description

      The documentation for `element::bool()` says

          Conversion operator to bool which is true for valid elements.

      This might be clearer thus:

          Conversion operator to bool which is true for valid elements and false for invalid elements.

      (Sadly, not all bool operators in the world really fully catch both sides of the condition.  Being clear that it does saves checking source to be certain, and so makes the library just a bit easier to use.)

        Attachments

          Activity

            People

            Assignee:
            jesse A. Jesse Jiryu Davis
            Reporter:
            jeff_abrahamson Jeff Abrahamson
            Participants:
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

              Dates

              Created:
              Updated:
              Resolved: