Uploaded image for project: 'C Driver'
  1. C Driver
  2. CDRIVER-4620

Docs incorrectly show bson_iter_as_double returns a bool

    • Type: Icon: Task Task
    • Resolution: Fixed
    • Priority: Icon: Unknown Unknown
    • 1.24.0
    • Affects Version/s: None
    • Component/s: Docs

      Summary

      The docs say that bson_iter_as_double returns a bool:

      bool
      bson_iter_as_double (const bson_iter_t *iter);
      

      http://mongoc.org/libbson/current/bson_iter_as_double.html 

      This should be changed to:

      double
      bson_iter_as_double (const bson_iter_t *iter);
      

      Motivation

      Who is the affected end user?

      Who are the stakeholders?

      How does this affect the end user?

      Are they blocked? Are they annoyed? Are they confused?

      How likely is it that this problem or use case will occur?

      Main path? Edge case?

      If the problem does occur, what are the consequences and how severe are they?

      Minor annoyance at a log message? Performance concern? Outage/unavailability? Failover can't complete?

      Is this issue urgent?

      Does this ticket have a required timeline? What is it?

      Is this ticket required by a downstream team?

      Needed by e.g. Atlas, Shell, Compass?

      Is this ticket only for tests?

      Does this ticket have any functional impact, or is it just test improvements?

      Acceptance Criteria

      What specific requirements must be met to consider the design phase complete?

            Assignee:
            josh.siegel@mongodb.com Josh Siegel
            Reporter:
            shane.harvey@mongodb.com Shane Harvey
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

              Created:
              Updated:
              Resolved: